folly/experimental/StringGen.h

   1 /*
   2  * Copyright 2013 Facebook, Inc.
   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 FOLLY_STRINGGEN_H_
  18 #define FOLLY_STRINGGEN_H_
  19
  20 #include "folly/Range.h"
  21
  22 namespace folly {
  23 namespace gen {
  24
  25 namespace detail {
  26 class StringResplitter;
  27 class SplitStringSource;
  28
  29 template<class Delimiter, class Output>
  30 class Unsplit;
  31
  32 template<class Delimiter, class OutputBuffer>
  33 class UnsplitBuffer;
  34 }  // namespace detail
  35
  36 /**
  37  * Split the output from a generator into StringPiece "lines" delimited by
  38  * the given delimiter.  Delimters are NOT included in the output.
  39  *
  40  * resplit() behaves as if the input strings were concatenated into one long
  41  * string and then split.
  42  */
  43 // make this a template so we don't require StringResplitter to be complete
  44 // until use
  45 template <class S=detail::StringResplitter>
  46 S resplit(char delimiter) {
  47   return S(delimiter);
  48 }
  49
  50 template <class S=detail::SplitStringSource>
  51 S split(const StringPiece& source, char delimiter) {
  52   return S(source, delimiter);
  53 }
  54
  55 /*
  56  * Joins a sequence of tokens into a string, with the chosen delimiter.
  57  *
  58  * E.G.
  59  *   fbstring result = split("a,b,c", ",") | unsplit(",");
  60  *   assert(result == "a,b,c");
  61  *
  62  *   std::string result = split("a,b,c", ",") | unsplit<std::string>(" ");
  63  *   assert(result == "a b c");
  64  */
  65
  66
  67 // NOTE: The template arguments are reversed to allow the user to cleanly
  68 // specify the output type while still inferring the type of the delimiter.
  69 template<class Output = folly::fbstring,
  70          class Delimiter,
  71          class Unsplit = detail::Unsplit<Delimiter, Output>>
  72 Unsplit unsplit(const Delimiter& delimiter) {
  73   return Unsplit(delimiter);
  74 }
  75
  76 /*
  77  * Joins a sequence of tokens into a string, appending them to the output
  78  * buffer.  If the output buffer is empty, an initial delimiter will not be
  79  * inserted at the start.
  80  *
  81  * E.G.
  82  *   std::string buffer;
  83  *   split("a,b,c", ",") | unsplit(",", &buffer);
  84  *   assert(buffer == "a,b,c");
  85  *
  86  *   std::string anotherBuffer("initial");
  87  *   split("a,b,c", ",") | unsplit(",", &anotherbuffer);
  88  *   assert(anotherBuffer == "initial,a,b,c");
  89  */
  90 template<class Delimiter,
  91          class OutputBuffer,
  92          class UnsplitBuffer = detail::UnsplitBuffer<Delimiter, OutputBuffer>>
  93 UnsplitBuffer unsplit(const Delimiter& delimiter, OutputBuffer* outputBuffer) {
  94   return UnsplitBuffer(delimiter, outputBuffer);
  95 }
  96
  97 }  // namespace gen
  98 }  // namespace folly
  99
 100 #include "folly/experimental/StringGen-inl.h"
 101
 102 #endif /* FOLLY_STRINGGEN_H_ */
 103