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
31// FieldMask related utility methods.
32
33#ifndef GOOGLE_PROTOBUF_UTIL_CONVERTER_FIELD_MASK_UTILITY_H__
34#define GOOGLE_PROTOBUF_UTIL_CONVERTER_FIELD_MASK_UTILITY_H__
35
36#include <functional>
37#include <stack>
38
39#include <google/protobuf/stubs/common.h>
40#include <google/protobuf/stubs/stringpiece.h>
41#include <google/protobuf/stubs/status.h>
42
43namespace google {
44namespace protobuf {
45namespace util {
46namespace converter {
47
48typedef string (*ConverterCallback)(StringPiece);
49typedef ResultCallback1<util::Status, StringPiece>* PathSinkCallback;
50
51// Applies a 'converter' to each segment of a FieldMask path and returns the
52// result. Quoted strings in the 'path' are copied to the output as-is without
53// converting their content. Escaping is supported within quoted strings.
54// For example, "ab\"_c" will be returned as "ab\"_c" without any changes.
55string ConvertFieldMaskPath(const StringPiece path,
56                            ConverterCallback converter);
57
58// Decodes a compact list of FieldMasks. For example, "a.b,a.c.d,a.c.e" will be
59// decoded into a list of field paths - "a.b", "a.c.d", "a.c.e". And the results
60// will be sent to 'path_sink', i.e. 'path_sink' will be called once per
61// resulting path.
62// Note that we also support Apiary style FieldMask form. The above example in
63// the Apiary style will look like "a.b,a.c(d,e)".
64util::Status DecodeCompactFieldMaskPaths(StringPiece paths,
65                                           PathSinkCallback path_sink);
66
67}  // namespace converter
68}  // namespace util
69}  // namespace protobuf
70
71}  // namespace google
72#endif  // GOOGLE_PROTOBUF_UTIL_CONVERTER_FIELD_MASK_UTILITY_H__
73