shell/inc/metainforeader.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_SHELL_INC_INTERNAL_METAINFOREADER_HXX
  21 #define INCLUDED_SHELL_INC_INTERNAL_METAINFOREADER_HXX
  22
  23 #include "basereader.hxx"
  24 #include "types.hxx"
  25 #include <stack>
  26 #include "filepath.hxx"
  27
  28 class ITag;
  29 class CKeywordsTag;
  30 class CSimpleTag;
  31 class CDummyTag;
  32
  33 class CMetaInfoReader : public CBaseReader
  34 {
  35 public:
  36     virtual ~CMetaInfoReader() override;
  37
  38     CMetaInfoReader(const Filepath_t& DocumentName);
  39
  40     CMetaInfoReader(StreamInterface* stream);
  41
  42     /** check if the Tag is in the target meta.xml file.
  43
  44         @param TagName
  45         the name of the tag that will be retrieved.
  46     */
  47     bool hasTag(const std::wstring& TagName) const;
  48
  49     /** Get a specific tag content, compound tags will be returned as comma separated list.
  50
  51         @param TagName
  52         the name of the tag that will be retrieved.
  53     */
  54     std::wstring getTagData(const std::wstring& TagName);
  55
  56     /** check if the a tag has the specific attribute.
  57
  58         @param TagName
  59         the name of the tag.
  60         @param AttributeName
  61         the name of the attribute.
  62     */
  63     bool hasTagAttribute(const std::wstring& TagName, const std::wstring& AttributeName);
  64
  65     /** Get a specific attribute content.
  66
  67         @param TagName
  68         the name of the tag.
  69         @param AttributeName
  70         the name of the attribute.
  71     */
  72     std::wstring getTagAttribute(const std::wstring& TagName, const std::wstring& AttributeName);
  73
  74     /** Get the default language of the whole document.
  75     */
  76     LocaleSet_t getDefaultLocale();
  77
  78 protected: // protected because its only an implementation relevant class
  79     /** start_element occurs when a tag is start.
  80
  81         @param raw_name
  82         raw name of the tag.
  83         @param local_name
  84         local name of the tag.
  85         @param attributes
  86         attribute structure.
  87     */
  88     virtual void start_element(const string_t& raw_name, const string_t& local_name,
  89                                const xml_tag_attribute_container_t& attributes) override;
  90
  91     /** end_element occurs when a tag is closed
  92
  93         @param raw_name
  94         raw name of the tag.
  95         @param local_name
  96         local name of the tag.
  97     */
  98     virtual void end_element(const string_t& raw_name, const string_t& local_name) override;
  99
 100     /** characters occurs when receiving characters
 101
 102         @param character
 103         content of the information received.
 104     */
 105     virtual void characters(const string_t& character) override;
 106
 107 protected:
 108     /** choose an appropriate tag reader to handle the tag.
 109
 110         @param tag_name
 111         the name of the tag.
 112         @param XmlAttributes
 113         attribute structure of the tag to save in.
 114     */
 115     ITag* chooseTagReader(const std::wstring& tag_name, const XmlTagAttributes_t& XmlAttributes);
 116
 117     /** save the received content into structure.
 118
 119         @param tag_name
 120         the name of the tag.
 121     */
 122     void saveTagContent(const std::wstring& tag_name);
 123
 124 private:
 125     XmlTags_t m_AllMetaInfo;
 126
 127 private:
 128     std::stack<ITag*> m_TagBuilderStack;
 129
 130 private:
 131     CKeywordsTag* m_pKeywords_Builder;
 132     CDummyTag* m_pDummy_Builder;
 133     CSimpleTag* m_pSimple_Builder;
 134 };
 135
 136 #endif
 137
 138 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */