xref: /aosp_15_r20/external/skia/modules/svg/include/SkSVGDOM.h (revision c8dee2aa9b3f27cf6c858bd81872bdeb2c07ed17)
1 /*
2  * Copyright 2016 Google Inc.
3  *
4  * Use of this source code is governed by a BSD-style license that can be
5  * found in the LICENSE file.
6  */
7 
8 #ifndef SkSVGDOM_DEFINED
9 #define SkSVGDOM_DEFINED
10 
11 #include "include/core/SkFontMgr.h"
12 #include "include/core/SkRefCnt.h"
13 #include "include/core/SkSize.h"
14 #include "include/private/base/SkAPI.h"
15 #include "modules/skresources/include/SkResources.h"
16 #include "modules/skshaper/include/SkShaper_factory.h"
17 #include "modules/svg/include/SkSVGIDMapper.h"
18 #include "modules/svg/include/SkSVGSVG.h"
19 
20 class SkCanvas;
21 class SkSVGNode;
22 class SkStream;
23 struct SkSVGPresentationContext;
24 
25 class SK_API SkSVGDOM : public SkRefCnt {
26 public:
27     class Builder final {
28     public:
29         /**
30          * Specify a font manager for loading fonts (e.g. from the system) to render <text>
31          * SVG nodes.
32          * If this is not set, but a font is required as part of rendering, the text will
33          * not be displayed.
34          */
35         Builder& setFontManager(sk_sp<SkFontMgr>);
36 
37         /**
38          * Specify a resource provider for loading images etc.
39          */
40         Builder& setResourceProvider(sk_sp<skresources::ResourceProvider>);
41 
42         /**
43          * Specify the callbacks for dealing with shaping text. See also
44          * modules/skshaper/utils/FactoryHelpers.h
45          */
46         Builder& setTextShapingFactory(sk_sp<SkShapers::Factory>);
47 
48         sk_sp<SkSVGDOM> make(SkStream&) const;
49 
50     private:
51         sk_sp<SkFontMgr>                             fFontMgr;
52         sk_sp<skresources::ResourceProvider>         fResourceProvider;
53         sk_sp<SkShapers::Factory>                    fTextShapingFactory;
54     };
55 
MakeFromStream(SkStream & str)56     static sk_sp<SkSVGDOM> MakeFromStream(SkStream& str) {
57         return Builder().make(str);
58     }
59 
60     /**
61      * Returns the root (outermost) SVG element.
62      */
getRoot()63     SkSVGSVG* getRoot() const { return fRoot.get(); }
64 
65     /**
66      * Specify a "container size" for the SVG dom.
67      *
68      * This is used to resolve the initial viewport when the root SVG width/height are specified
69      * in relative units.
70      *
71      * If the root dimensions are in absolute units, then the container size has no effect since
72      * the initial viewport is fixed.
73      */
74     void setContainerSize(const SkSize&);
75 
76     /**
77      * DEPRECATED: use getRoot()->intrinsicSize() to query the root element intrinsic size.
78      *
79      * Returns the SVG dom container size.
80      *
81      * If the client specified a container size via setContainerSize(), then the same size is
82      * returned.
83      *
84      * When unspecified by clients, this returns the intrinsic size of the root element, as defined
85      * by its width/height attributes.  If either width or height is specified in relative units
86      * (e.g. "100%"), then the corresponding intrinsic size dimension is zero.
87      */
88     const SkSize& containerSize() const;
89 
90     // Returns the node with the given id, or nullptr if not found.
91     sk_sp<SkSVGNode>* findNodeById(const char* id);
92 
93     void render(SkCanvas*) const;
94 
95     /** Render the node with the given id as if it were the only child of the root. */
96     void renderNode(SkCanvas*, SkSVGPresentationContext&, const char* id) const;
97 
98 private:
99     SkSVGDOM(sk_sp<SkSVGSVG>,
100              sk_sp<SkFontMgr>,
101              sk_sp<skresources::ResourceProvider>,
102              SkSVGIDMapper&&,
103              sk_sp<SkShapers::Factory>);
104 
105     const sk_sp<SkSVGSVG>                       fRoot;
106     const sk_sp<SkFontMgr>                      fFontMgr;
107     const sk_sp<SkShapers::Factory>             fTextShapingFactory;
108     const sk_sp<skresources::ResourceProvider>  fResourceProvider;
109     const SkSVGIDMapper                         fIDMapper;
110     SkSize                                      fContainerSize;
111 };
112 
113 #endif // SkSVGDOM_DEFINED
114