summaryrefslogtreecommitdiff
path: root/shell/inc/metainforeader.hxx
blob: 6a4e82527e0f74cdd09423fbca7ee29e10e5727f (plain)
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
138
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef INCLUDED_SHELL_INC_INTERNAL_METAINFOREADER_HXX
#define INCLUDED_SHELL_INC_INTERNAL_METAINFOREADER_HXX

#include "basereader.hxx"
#include "types.hxx"
#include <stack>
#include "filepath.hxx"

class ITag;
class CKeywordsTag;
class CSimpleTag;
class CDummyTag;

class CMetaInfoReader : public CBaseReader
{
public:
    virtual ~CMetaInfoReader() override;

    CMetaInfoReader(const Filepath_t& DocumentName);

    CMetaInfoReader(StreamInterface* stream);

    /** check if the Tag is in the target meta.xml file.

        @param TagName
        the name of the tag that will be retrieved.
    */
    bool hasTag(const std::wstring& TagName) const;

    /** Get a specific tag content, compound tags will be returned as comma separated list.

        @param TagName
        the name of the tag that will be retrieved.
    */
    std::wstring getTagData(const std::wstring& TagName);

    /** check if the a tag has the specific attribute.

        @param TagName
        the name of the tag.
        @param AttributeName
        the name of the attribute.
    */
    bool hasTagAttribute(const std::wstring& TagName, const std::wstring& AttributeName);

    /** Get a specific attribute content.

        @param TagName
        the name of the tag.
        @param AttributeName
        the name of the attribute.
    */
    std::wstring getTagAttribute(const std::wstring& TagName, const std::wstring& AttributeName);

    /** Get the default language of the whole document.
    */
    LocaleSet_t getDefaultLocale();

protected: // protected because its only an implementation relevant class
    /** start_element occurs when a tag is start.

        @param raw_name
        raw name of the tag.
        @param local_name
        local name of the tag.
        @param attributes
        attribute structure.
    */
    virtual void start_element(const string_t& raw_name, const string_t& local_name,
                               const xml_tag_attribute_container_t& attributes) override;

    /** end_element occurs when a tag is closed

        @param raw_name
        raw name of the tag.
        @param local_name
        local name of the tag.
    */
    virtual void end_element(const string_t& raw_name, const string_t& local_name) override;

    /** characters occurs when receiving characters

        @param character
        content of the information received.
    */
    virtual void characters(const string_t& character) override;

protected:
    /** choose an appropriate tag reader to handle the tag.

        @param tag_name
        the name of the tag.
        @param XmlAttributes
        attribute structure of the tag to save in.
    */
    ITag* chooseTagReader(const std::wstring& tag_name, const XmlTagAttributes_t& XmlAttributes);

    /** save the received content into structure.

        @param tag_name
        the name of the tag.
    */
    void saveTagContent(const std::wstring& tag_name);

private:
    XmlTags_t m_AllMetaInfo;

private:
    std::stack<ITag*> m_TagBuilderStack;

private:
    CKeywordsTag* m_pKeywords_Builder;
    CDummyTag* m_pDummy_Builder;
    CSimpleTag* m_pSimple_Builder;
};

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */