xref: /aosp_15_r20/external/skia/src/xml/SkXMLWriter.h (revision c8dee2aa9b3f27cf6c858bd81872bdeb2c07ed17)
1*c8dee2aaSAndroid Build Coastguard Worker /*
2*c8dee2aaSAndroid Build Coastguard Worker  * Copyright 2006 The Android Open Source Project
3*c8dee2aaSAndroid Build Coastguard Worker  *
4*c8dee2aaSAndroid Build Coastguard Worker  * Use of this source code is governed by a BSD-style license that can be
5*c8dee2aaSAndroid Build Coastguard Worker  * found in the LICENSE file.
6*c8dee2aaSAndroid Build Coastguard Worker  */
7*c8dee2aaSAndroid Build Coastguard Worker 
8*c8dee2aaSAndroid Build Coastguard Worker #ifndef SkXMLWriter_DEFINED
9*c8dee2aaSAndroid Build Coastguard Worker #define SkXMLWriter_DEFINED
10*c8dee2aaSAndroid Build Coastguard Worker 
11*c8dee2aaSAndroid Build Coastguard Worker #include "include/core/SkString.h"
12*c8dee2aaSAndroid Build Coastguard Worker #include "include/private/base/SkTDArray.h"
13*c8dee2aaSAndroid Build Coastguard Worker #include "src/xml/SkDOM.h"
14*c8dee2aaSAndroid Build Coastguard Worker 
15*c8dee2aaSAndroid Build Coastguard Worker class SkWStream;
16*c8dee2aaSAndroid Build Coastguard Worker class SkXMLParser;
17*c8dee2aaSAndroid Build Coastguard Worker 
18*c8dee2aaSAndroid Build Coastguard Worker class SkXMLWriter {
19*c8dee2aaSAndroid Build Coastguard Worker public:
20*c8dee2aaSAndroid Build Coastguard Worker             SkXMLWriter(bool doEscapeMarkup = true);
21*c8dee2aaSAndroid Build Coastguard Worker     virtual ~SkXMLWriter();
22*c8dee2aaSAndroid Build Coastguard Worker 
23*c8dee2aaSAndroid Build Coastguard Worker     void    addS32Attribute(const char name[], int32_t value);
24*c8dee2aaSAndroid Build Coastguard Worker     void    addAttribute(const char name[], const char value[]);
25*c8dee2aaSAndroid Build Coastguard Worker     void    addAttributeLen(const char name[], const char value[], size_t length);
26*c8dee2aaSAndroid Build Coastguard Worker     void    addHexAttribute(const char name[], uint32_t value, int minDigits = 0);
27*c8dee2aaSAndroid Build Coastguard Worker     void    addScalarAttribute(const char name[], SkScalar value);
28*c8dee2aaSAndroid Build Coastguard Worker     void    addText(const char text[], size_t length);
endElement()29*c8dee2aaSAndroid Build Coastguard Worker     void    endElement() { this->onEndElement(); }
30*c8dee2aaSAndroid Build Coastguard Worker     void    startElement(const char elem[]);
31*c8dee2aaSAndroid Build Coastguard Worker     void    startElementLen(const char elem[], size_t length);
32*c8dee2aaSAndroid Build Coastguard Worker     void    writeDOM(const SkDOM&, const SkDOM::Node*, bool skipRoot);
33*c8dee2aaSAndroid Build Coastguard Worker     void    flush();
34*c8dee2aaSAndroid Build Coastguard Worker     virtual void writeHeader();
35*c8dee2aaSAndroid Build Coastguard Worker 
36*c8dee2aaSAndroid Build Coastguard Worker protected:
37*c8dee2aaSAndroid Build Coastguard Worker     virtual void onStartElementLen(const char elem[], size_t length) = 0;
38*c8dee2aaSAndroid Build Coastguard Worker     virtual void onAddAttributeLen(const char name[], const char value[], size_t length) = 0;
39*c8dee2aaSAndroid Build Coastguard Worker     virtual void onAddText(const char text[], size_t length) = 0;
40*c8dee2aaSAndroid Build Coastguard Worker     virtual void onEndElement() = 0;
41*c8dee2aaSAndroid Build Coastguard Worker 
42*c8dee2aaSAndroid Build Coastguard Worker     struct Elem {
ElemElem43*c8dee2aaSAndroid Build Coastguard Worker         Elem(const char name[], size_t len)
44*c8dee2aaSAndroid Build Coastguard Worker             : fName(name, len)
45*c8dee2aaSAndroid Build Coastguard Worker             , fHasChildren(false)
46*c8dee2aaSAndroid Build Coastguard Worker             , fHasText(false) {}
47*c8dee2aaSAndroid Build Coastguard Worker 
48*c8dee2aaSAndroid Build Coastguard Worker         SkString    fName;
49*c8dee2aaSAndroid Build Coastguard Worker         bool        fHasChildren;
50*c8dee2aaSAndroid Build Coastguard Worker         bool        fHasText;
51*c8dee2aaSAndroid Build Coastguard Worker     };
52*c8dee2aaSAndroid Build Coastguard Worker     void doEnd(Elem* elem);
53*c8dee2aaSAndroid Build Coastguard Worker     bool doStart(const char name[], size_t length);
54*c8dee2aaSAndroid Build Coastguard Worker     Elem* getEnd();
55*c8dee2aaSAndroid Build Coastguard Worker     const char* getHeader();
56*c8dee2aaSAndroid Build Coastguard Worker     SkTDArray<Elem*> fElems;
57*c8dee2aaSAndroid Build Coastguard Worker 
58*c8dee2aaSAndroid Build Coastguard Worker private:
59*c8dee2aaSAndroid Build Coastguard Worker     bool fDoEscapeMarkup;
60*c8dee2aaSAndroid Build Coastguard Worker     // illegal
61*c8dee2aaSAndroid Build Coastguard Worker     SkXMLWriter& operator=(const SkXMLWriter&);
62*c8dee2aaSAndroid Build Coastguard Worker };
63*c8dee2aaSAndroid Build Coastguard Worker 
64*c8dee2aaSAndroid Build Coastguard Worker class SkXMLStreamWriter : public SkXMLWriter {
65*c8dee2aaSAndroid Build Coastguard Worker public:
66*c8dee2aaSAndroid Build Coastguard Worker     enum : uint32_t {
67*c8dee2aaSAndroid Build Coastguard Worker         kNoPretty_Flag = 0x01,
68*c8dee2aaSAndroid Build Coastguard Worker     };
69*c8dee2aaSAndroid Build Coastguard Worker 
70*c8dee2aaSAndroid Build Coastguard Worker     SkXMLStreamWriter(SkWStream*, uint32_t flags = 0);
71*c8dee2aaSAndroid Build Coastguard Worker     ~SkXMLStreamWriter() override;
72*c8dee2aaSAndroid Build Coastguard Worker     void writeHeader() override;
73*c8dee2aaSAndroid Build Coastguard Worker 
74*c8dee2aaSAndroid Build Coastguard Worker protected:
75*c8dee2aaSAndroid Build Coastguard Worker     void onStartElementLen(const char elem[], size_t length) override;
76*c8dee2aaSAndroid Build Coastguard Worker     void onEndElement() override;
77*c8dee2aaSAndroid Build Coastguard Worker     void onAddAttributeLen(const char name[], const char value[], size_t length) override;
78*c8dee2aaSAndroid Build Coastguard Worker     void onAddText(const char text[], size_t length) override;
79*c8dee2aaSAndroid Build Coastguard Worker 
80*c8dee2aaSAndroid Build Coastguard Worker private:
81*c8dee2aaSAndroid Build Coastguard Worker     void newline();
82*c8dee2aaSAndroid Build Coastguard Worker     void tab(int lvl);
83*c8dee2aaSAndroid Build Coastguard Worker 
84*c8dee2aaSAndroid Build Coastguard Worker     SkWStream&      fStream;
85*c8dee2aaSAndroid Build Coastguard Worker     const uint32_t  fFlags;
86*c8dee2aaSAndroid Build Coastguard Worker };
87*c8dee2aaSAndroid Build Coastguard Worker 
88*c8dee2aaSAndroid Build Coastguard Worker class SkXMLParserWriter : public SkXMLWriter {
89*c8dee2aaSAndroid Build Coastguard Worker public:
90*c8dee2aaSAndroid Build Coastguard Worker     SkXMLParserWriter(SkXMLParser*);
91*c8dee2aaSAndroid Build Coastguard Worker     ~SkXMLParserWriter() override;
92*c8dee2aaSAndroid Build Coastguard Worker protected:
93*c8dee2aaSAndroid Build Coastguard Worker     void onStartElementLen(const char elem[], size_t length) override;
94*c8dee2aaSAndroid Build Coastguard Worker     void onEndElement() override;
95*c8dee2aaSAndroid Build Coastguard Worker     void onAddAttributeLen(const char name[], const char value[], size_t length) override;
96*c8dee2aaSAndroid Build Coastguard Worker     void onAddText(const char text[], size_t length) override;
97*c8dee2aaSAndroid Build Coastguard Worker private:
98*c8dee2aaSAndroid Build Coastguard Worker     SkXMLParser&        fParser;
99*c8dee2aaSAndroid Build Coastguard Worker };
100*c8dee2aaSAndroid Build Coastguard Worker 
101*c8dee2aaSAndroid Build Coastguard Worker 
102*c8dee2aaSAndroid Build Coastguard Worker #endif
103