shell/inc/internal/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 METAINFOREADER_HXX_INCLUDED
  21 #define METAINFOREADER_HXX_INCLUDED
  22
  23 #include "internal/basereader.hxx"
  24 #include "internal/types.hxx"
  25
  26 class ITag;
  27 class CKeywordsTag;
  28 class CSimpleTag;
  29 class CDummyTag;
  30
  31 class CMetaInfoReader : public CBaseReader
  32 {
  33 public:
  34     virtual ~CMetaInfoReader();
  35
  36     CMetaInfoReader( const std::string& DocumentName );
  37
  38     CMetaInfoReader( StreamInterface* stream );
  39
  40     /** check if the Tag is in the target meta.xml file.
  41
  42         @param TagName
  43         the name of the tag that will be retrive.
  44     */
  45     bool hasTag(std::wstring TagName) const;
  46
  47
  48     /** Get a specific tag content, compound tags will be returned as comma separated list.
  49
  50         @param TagName
  51         the name of the tag that will be retrive.
  52     */
  53     std::wstring getTagData( const std::wstring& TagName);
  54
  55     /** check if the a tag has the specific attribute.
  56
  57         @param TagName
  58         the name of the tag.
  59         @param AttributeName
  60         the name of the attribute.
  61     */
  62     bool hasTagAttribute( const std::wstring TagName,  std::wstring AttributeName);
  63
  64     /** Get a specific attribute content.
  65
  66         @param TagName
  67         the name of the tag.
  68         @param AttributeName
  69         the name of the attribute.
  70     */
  71     std::wstring getTagAttribute( const std::wstring TagName,  std::wstring AttributeName);
  72
  73     /** Get the default language of the whole document.
  74     */
  75     LocaleSet_t getDefaultLocale( );
  76
  77 protected: // protected because its only an implementation relevant class
  78
  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(
  89         const std::wstring& raw_name,
  90         const std::wstring& local_name,
  91         const XmlTagAttributes_t& attributes);
  92
  93     /** end_element occurs when a tag is closed
  94
  95         @param raw_name
  96         raw name of the tag.
  97         @param local_name
  98         local name of the tag.
  99     */
 100     virtual void end_element(
 101         const std::wstring& raw_name, const std::wstring& local_name);
 102
 103     /** characters occurs when receiving characters
 104
 105         @param character
 106         content of the information received.
 107     */
 108     virtual void characters(const std::wstring& character);
 109
 110 protected:
 111     /** choose an appropriate tag reader to handle the tag.
 112
 113         @param tag_name
 114         the name of the tag.
 115         @param XmlAttributes
 116         attribute structure of the tag to save in.
 117     */
 118     ITag* chooseTagReader(
 119         const std::wstring& tag_name, const XmlTagAttributes_t& XmlAttributes );
 120
 121     /** save the received content into structure.
 122
 123         @param tag_name
 124         the name of the tag.
 125     */
 126     void saveTagContent( const std::wstring& tag_name );
 127
 128 private:
 129     XmlTags_t      m_AllMetaInfo;
 130
 131 private:
 132     std::stack<ITag*> m_TagBuilderStack;
 133
 134 private:
 135     CKeywordsTag* m_pKeywords_Builder;
 136     CDummyTag*   m_pDummy_Builder;
 137     CSimpleTag* m_pSimple_Builder;
 138 };
 139
 140 #endif
 141
 142 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */