field_mask_utility.h 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. // Protocol Buffers - Google's data interchange format
  2. // Copyright 2008 Google Inc. All rights reserved.
  3. // https://developers.google.com/protocol-buffers/
  4. //
  5. // Redistribution and use in source and binary forms, with or without
  6. // modification, are permitted provided that the following conditions are
  7. // met:
  8. //
  9. // * Redistributions of source code must retain the above copyright
  10. // notice, this list of conditions and the following disclaimer.
  11. // * Redistributions in binary form must reproduce the above
  12. // copyright notice, this list of conditions and the following disclaimer
  13. // in the documentation and/or other materials provided with the
  14. // distribution.
  15. // * Neither the name of Google Inc. nor the names of its
  16. // contributors may be used to endorse or promote products derived from
  17. // this software without specific prior written permission.
  18. //
  19. // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20. // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21. // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22. // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23. // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24. // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25. // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26. // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27. // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28. // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29. // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30. // FieldMask related utility methods.
  31. #ifndef GOOGLE_PROTOBUF_UTIL_CONVERTER_FIELD_MASK_UTILITY_H__
  32. #define GOOGLE_PROTOBUF_UTIL_CONVERTER_FIELD_MASK_UTILITY_H__
  33. #include <functional>
  34. #include <stack>
  35. #include <google/protobuf/stubs/common.h>
  36. #include <google/protobuf/stubs/stringpiece.h>
  37. #include <google/protobuf/stubs/status.h>
  38. namespace google {
  39. namespace protobuf {
  40. namespace util {
  41. namespace converter {
  42. typedef string (*ConverterCallback)(StringPiece);
  43. typedef ResultCallback1<util::Status, StringPiece>* PathSinkCallback;
  44. // Applies a 'converter' to each segment of a FieldMask path and returns the
  45. // result. Quoted strings in the 'path' are copied to the output as-is without
  46. // converting their content. Escaping is supported within quoted strings.
  47. // For example, "ab\"_c" will be returned as "ab\"_c" without any changes.
  48. string ConvertFieldMaskPath(const StringPiece path,
  49. ConverterCallback converter);
  50. // Decodes a compact list of FieldMasks. For example, "a.b,a.c.d,a.c.e" will be
  51. // decoded into a list of field paths - "a.b", "a.c.d", "a.c.e". And the results
  52. // will be sent to 'path_sink', i.e. 'path_sink' will be called once per
  53. // resulting path.
  54. // Note that we also support Apiary style FieldMask form. The above example in
  55. // the Apiary style will look like "a.b,a.c(d,e)".
  56. util::Status DecodeCompactFieldMaskPaths(StringPiece paths,
  57. PathSinkCallback path_sink);
  58. } // namespace converter
  59. } // namespace util
  60. } // namespace protobuf
  61. } // namespace google
  62. #endif // GOOGLE_PROTOBUF_UTIL_CONVERTER_FIELD_MASK_UTILITY_H__