/usr/include/ctemplate/template_annotator.h is in libctemplate-dev 2.2-4ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 | // Copyright (c) 2009, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// ---
//
// The template expansion system provides a set of hooks that allow for
// the insertion of diagnostic content into the output stream for the use
// by content developers and testers. For instance, the default text
// annotation mode inserts strings bracketed by {{ }} to describe every
// occurrence of a dynamic substitution feature. That mode turns the
// rendering into a logical text description of the construction of
// template-based output. It is useful for regression testing of output
// in conjunction with text-based diffing tools.
//
// An annotation mode is implemented with the TemplateAnnotator interface.
// When template annotation is turned on, then during template expansion
// whenever a dynamic substitution feature is encountered, a call is made
// to one of the TemplateAnnotator functions. In response to a call
// an implementation can render any additional content into the passed
// emitter, which is the same emitter that the rendering output is going
// to.
//
// Template annotation is turned on and the template annotator subclass
// set by methods in ::ctemplate::PerExpandData.
#ifndef TEMPLATE_TEMPLATE_ANNOTATOR_H_
#define TEMPLATE_TEMPLATE_ANNOTATOR_H_
#include <string>
namespace ctemplate {
class ExpandEmitter;
// This is the abstract interface for an annotation mode. A new annotation
// mode is introduced by subclassing and implementing each function
// to add annotation content. There is one function for each internal
// template expansion event type. The emitter argument passed to the
// function is the same stream that the expanding content is being output to;
// so the action of an implementation will be to add additional inline
// content. The emitter argument is never to be remembered beyond each
// function call.
class TemplateAnnotator {
public:
TemplateAnnotator() { }
virtual ~TemplateAnnotator() { }
// Called before processing a subtemplate include marker.
// Passed value is the include marker name.
virtual void EmitOpenInclude(ExpandEmitter* emitter, const std::string& value) = 0;
// Called after processing a subtemplate include marker.
virtual void EmitCloseInclude(ExpandEmitter* emitter) = 0;
// Called before opening a template or subtemplate file for processing.
// Passed value is the filename.
virtual void EmitOpenFile(ExpandEmitter* emitter, const std::string& value) = 0;
// Called after processing a template or subtemplate file.
virtual void EmitCloseFile(ExpandEmitter* emitter) = 0;
// Called before processing a section.
// Passed value is the section name.
virtual void EmitOpenSection(ExpandEmitter* emitter, const std::string& value) = 0;
// Called after processing a section.
virtual void EmitCloseSection(ExpandEmitter* emitter) = 0;
// Called before processing a variable marker.
// Passed value is the variable name.
virtual void EmitOpenVariable(ExpandEmitter* emitter,
const std::string& value) = 0;
// Called after processing a variable marker.
virtual void EmitCloseVariable(ExpandEmitter* emitter) = 0;
virtual void EmitFileIsMissing(ExpandEmitter* emitter,
const std::string& value) = 0;
private:
// Can't invoke copy constructor or assignment operator
TemplateAnnotator(const TemplateAnnotator&);
void operator=(const TemplateAnnotator&);
};
// This is a concrete template annotator class that inserts annotations
// that have a standard text form bracketed by {{ }}. It is used as
// the default annotation implementation when annotation is turned on
// by PerExpandData and no annotator type is specified.
class TextTemplateAnnotator : public TemplateAnnotator {
public:
TextTemplateAnnotator() { }
virtual void EmitOpenInclude(ExpandEmitter* emitter, const std::string& value);
virtual void EmitCloseInclude(ExpandEmitter* emitter);
virtual void EmitOpenFile(ExpandEmitter* emitter, const std::string& value);
virtual void EmitCloseFile(ExpandEmitter* emitter);
virtual void EmitOpenSection(ExpandEmitter* emitter, const std::string& value);
virtual void EmitCloseSection(ExpandEmitter* emitter);
virtual void EmitOpenVariable(ExpandEmitter* emitter, const std::string& value);
virtual void EmitCloseVariable(ExpandEmitter* emitter);
virtual void EmitFileIsMissing(ExpandEmitter* emitter,
const std::string& value);
private:
// Can't invoke copy constructor or assignment operator
TextTemplateAnnotator(const TextTemplateAnnotator&);
void operator=(const TextTemplateAnnotator&);
};
}
#endif // TEMPLATE_TEMPLATE_ANNOTATOR_H_
|