Home | History | Annotate | Download | only in strings
      1 /*
      2  * Copyright (C) 2018 The Android Open Source Project
      3  *
      4  * Licensed under the Apache License, Version 2.0 (the "License");
      5  * you may not use this file except in compliance with the License.
      6  * You may obtain a copy of the License at
      7  *
      8  *      http://www.apache.org/licenses/LICENSE-2.0
      9  *
     10  * Unless required by applicable law or agreed to in writing, software
     11  * distributed under the License is distributed on an "AS IS" BASIS,
     12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     13  * See the License for the specific language governing permissions and
     14  * limitations under the License.
     15  */
     16 
     17 #ifndef LIBTEXTCLASSIFIER_UTILS_STRINGS_SUBSTITUTE_H_
     18 #define LIBTEXTCLASSIFIER_UTILS_STRINGS_SUBSTITUTE_H_
     19 
     20 #include <string>
     21 #include <vector>
     22 
     23 #include "utils/strings/stringpiece.h"
     24 
     25 namespace libtextclassifier3 {
     26 namespace strings {
     27 
     28 // Formats a string with argument-binding.
     29 // Uses a format string that contains positional identifiers indicated by a
     30 // dollar sign ($) and a signle digit positional id to indicate which
     31 // substitution arguments to use at that location within the format string.
     32 // A '$$' sequence in the format string means output a literal '$' character.
     33 // Returns whether the substitution was successful.
     34 bool Substitute(const StringPiece format, const std::vector<StringPiece>& args,
     35                 std::string* output);
     36 
     37 std::string Substitute(const StringPiece format,
     38                        const std::vector<StringPiece>& args);
     39 
     40 }  // namespace strings
     41 }  // namespace libtextclassifier3
     42 
     43 #endif  // LIBTEXTCLASSIFIER_UTILS_STRINGS_SUBSTITUTE_H_
     44