diff options
Diffstat (limited to 'autodoc/inc/ary/info')
-rw-r--r-- | autodoc/inc/ary/info/all_dts.hxx | 160 | ||||
-rw-r--r-- | autodoc/inc/ary/info/all_tags.hxx | 289 | ||||
-rw-r--r-- | autodoc/inc/ary/info/ci_attag.hxx | 101 | ||||
-rw-r--r-- | autodoc/inc/ary/info/ci_text.hxx | 85 | ||||
-rw-r--r-- | autodoc/inc/ary/info/docstore.hxx | 116 | ||||
-rw-r--r-- | autodoc/inc/ary/info/infodisp.hxx | 114 | ||||
-rw-r--r-- | autodoc/inc/ary/info/inftypes.hxx | 122 |
7 files changed, 987 insertions, 0 deletions
diff --git a/autodoc/inc/ary/info/all_dts.hxx b/autodoc/inc/ary/info/all_dts.hxx new file mode 100644 index 000000000000..58aee2a5e50d --- /dev/null +++ b/autodoc/inc/ary/info/all_dts.hxx @@ -0,0 +1,160 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef ARY_INFO_ALL_DTS_HXX +#define ARY_INFO_ALL_DTS_HXX + + + +// USED SERVICES + // BASE CLASSES + // COMPONENTS + // PARAMETERS + + +namespace ary +{ +namespace info +{ + +class DocuDisplay; + +class DocuToken +{ + public: + virtual ~DocuToken() {} + + void StoreAt( + DocuDisplay & o_rDisplay ) const; + bool IsWhite() const; + + private: + virtual void do_StoreAt( + DocuDisplay & o_rDisplay ) const = 0; + virtual bool inq_IsWhite() const = 0; +}; + +class DT_Text : public DocuToken +{ + public: + DT_Text( + const char * i_sText ) + : sText( i_sText ) {} + + const String & Text() const { return sText; } + + private: + virtual void do_StoreAt( + DocuDisplay & o_rDisplay ) const; + virtual bool inq_IsWhite() const; + + String sText; +}; + +class DT_MaybeLink : public DocuToken +{ + public: + DT_MaybeLink( + const char * i_sText, + bool i_bIsGlobal, + bool i_bIsFunction ) + : sText( i_sText ), + bIsGlobal(i_bIsGlobal), + bIsFunction(i_bIsFunction) { } + + const String & Text() const { return sText; } + bool IsAbsolute() const { return bIsGlobal; } + bool IsFunction() const { return bIsFunction; } + + private: + virtual void do_StoreAt( + DocuDisplay & o_rDisplay ) const; + virtual bool inq_IsWhite() const; + + String sText; + bool bIsGlobal; + bool bIsFunction; +}; + +class DT_Whitespace : public DocuToken +{ + public: + DT_Whitespace( + UINT8 i_nLength ) + : nLength( i_nLength ) {} + UINT8 Length() const { return nLength; } + + private: + virtual void do_StoreAt( + DocuDisplay & o_rDisplay ) const; + virtual bool inq_IsWhite() const; + + UINT8 nLength; +}; + + +class DT_Eol : public DocuToken +{ + virtual void do_StoreAt( + DocuDisplay & o_rDisplay ) const; + virtual bool inq_IsWhite() const; +}; + +class DT_Xml : public DocuToken +{ + public: + DT_Xml( + const char * i_sText ) + : sText( i_sText ) {} + + const String & Text() const { return sText; } + + private: + virtual void do_StoreAt( + DocuDisplay & o_rDisplay ) const; + virtual bool inq_IsWhite() const; + + String sText; +}; + + +// IMPLEMENTATION + +inline void +DocuToken::StoreAt( DocuDisplay & o_rDisplay ) const + { do_StoreAt(o_rDisplay); } +inline bool +DocuToken::IsWhite() const + { return inq_IsWhite(); } + + + +} +} + +#endif + diff --git a/autodoc/inc/ary/info/all_tags.hxx b/autodoc/inc/ary/info/all_tags.hxx new file mode 100644 index 000000000000..bd2de713f22c --- /dev/null +++ b/autodoc/inc/ary/info/all_tags.hxx @@ -0,0 +1,289 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef ARY_INFO_ALL_TAGS_HXX +#define ARY_INFO_ALL_TAGS_HXX + + + +// USED SERVICES + // BASE CLASSES +#include <ary/info/ci_attag.hxx> + // COMPONENTS +#include <ary/info/inftypes.hxx> +#include <ary/info/ci_text.hxx> +#include <ary/qualiname.hxx> + // PARAMETERS + + + +namespace ary +{ +namespace info +{ + + +class StdTag : public AtTag +{ + public: + StdTag( + E_AtTagId i_eId ); + + virtual bool Add_SpecialMeaningToken( + const char * i_sText, + intt i_nNr ); + void ChangeId2( + E_AtTagId i_eId ) + { eId = i_eId; } + + virtual UINT8 NrOfSpecialMeaningTokens() const; + virtual AtTag * GetFollower(); + + E_AtTagId Std_Id() const { return eId; } + + private: + virtual void do_StoreAt( + DocuDisplay & o_rDisplay ) const; + virtual DocuText * Text(); + + E_AtTagId eId; + DocuText aText; + StdTag * pNext; +}; + +class BaseTag : public AtTag +{ + public: + BaseTag(); + + virtual bool Add_SpecialMeaningToken( + const char * i_sText, + intt i_nNr ); + virtual const char * + Title() const; + virtual UINT8 NrOfSpecialMeaningTokens() const; + virtual AtTag * GetFollower(); + + private: + virtual DocuText * Text(); + + QualifiedName sBase; + DocuText aText; + AtTag * pNext; +}; + +class ExceptionTag : public AtTag +{ + public: + ExceptionTag(); + + virtual bool Add_SpecialMeaningToken( + const char * i_sText, + intt i_nNr ); + virtual const char * + Title() const; + virtual UINT8 NrOfSpecialMeaningTokens() const; + virtual AtTag * GetFollower(); + + private: + virtual DocuText * Text(); + + QualifiedName sException; + DocuText aText; + AtTag * pNext; +}; + +class ImplementsTag : public AtTag +{ + public: + ImplementsTag(); + + virtual bool Add_SpecialMeaningToken( + const char * i_sText, + intt i_nNr ); + virtual const char * + Title() const; + virtual UINT8 NrOfSpecialMeaningTokens() const; + virtual AtTag * GetFollower(); + + private: + virtual DocuText * Text(); + + QualifiedName sName; + AtTag * pNext; +}; + +class KeywordTag : public AtTag +{ + public: + KeywordTag(); + + virtual bool Add_SpecialMeaningToken( + const char * i_sText, + intt i_nNr ); + virtual const char * + Title() const; + virtual UINT8 NrOfSpecialMeaningTokens() const; + virtual AtTag * GetFollower(); + + private: + virtual DocuText * Text(); + + StringVector sKeys; +}; + +class ParameterTag : public AtTag +{ + public: + ParameterTag(); + + virtual bool Add_SpecialMeaningToken( + const char * i_sText, + intt i_nNr ); + + const String & ParamName() const { return sName; } + const DocuText & CText() const { return aText; } + virtual UINT8 NrOfSpecialMeaningTokens() const; + virtual const ParameterTag * + GetNext() const { return dynamic_cast< ParameterTag* >(pNext); } + virtual AtTag * GetFollower(); + + private: + virtual void do_StoreAt( + DocuDisplay & o_rDisplay ) const; + virtual DocuText * Text(); + + String sName; + String sValidRange; + DocuText aText; + AtTag * pNext; +}; + +class SeeTag : public AtTag +{ + public: + SeeTag(); + + virtual bool Add_SpecialMeaningToken( + const char * i_sText, + intt i_nNr ); + virtual const char * + Title() const; + virtual UINT8 NrOfSpecialMeaningTokens() const; + virtual AtTag * GetFollower(); + + const std::vector< QualifiedName > & + References() const { return sReferences; } + private: + virtual void do_StoreAt( + DocuDisplay & o_rDisplay ) const; + virtual DocuText * Text(); + + std::vector< QualifiedName > + sReferences; +}; + +class TemplateTag : public AtTag +{ + public: + TemplateTag(); + + virtual bool Add_SpecialMeaningToken( + const char * i_sText, + intt i_nNr ); + const DocuText & CText() const { return aText; } + virtual const char * + Title() const; + const String & TplParamName() const { return sName; } + virtual UINT8 NrOfSpecialMeaningTokens() const; + virtual const TemplateTag * + GetNext() const { return dynamic_cast< TemplateTag* >(pNext); } + virtual AtTag * GetFollower(); + + private: + virtual void do_StoreAt( + DocuDisplay & o_rDisplay ) const; + virtual DocuText * Text(); + + String sName; + DocuText aText; + AtTag * pNext; +}; + +class LabelTag : public AtTag +{ + public: + LabelTag(); + + virtual bool Add_SpecialMeaningToken( + const char * i_sText, + intt i_nNr ); + virtual const char * + Title() const; + virtual UINT8 NrOfSpecialMeaningTokens() const; + virtual AtTag * GetFollower(); + + private: + virtual DocuText * Text(); + + String sLabel; +}; + +class SinceTag : public AtTag +{ + public: + SinceTag(); + + virtual bool Add_SpecialMeaningToken( + const char * i_sText, + intt i_nNr ); + virtual const char * + Title() const; + virtual UINT8 NrOfSpecialMeaningTokens() const; + virtual AtTag * GetFollower(); + + const String & Version() const { return sVersion; } + + private: + virtual void do_StoreAt( + DocuDisplay & o_rDisplay ) const; + virtual DocuText * Text(); + + // Data + String sVersion; +}; + + + +// IMPLEMENTATION + + +} +} + +#endif + diff --git a/autodoc/inc/ary/info/ci_attag.hxx b/autodoc/inc/ary/info/ci_attag.hxx new file mode 100644 index 000000000000..da487a86f7fb --- /dev/null +++ b/autodoc/inc/ary/info/ci_attag.hxx @@ -0,0 +1,101 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef ARY_INFO_CI_ATTAG_HXX +#define ARY_INFO_CI_ATTAG_HXX + + + +// USED SERVICES + // BASE CLASSES + // COMPONENTS + // PARAMETERS + + + +namespace ary +{ +namespace info +{ + +class DocuText; +class DocuDisplay; + +class AtTag +{ + public: + virtual ~AtTag() {} + + void Set_HtmlUseInDocuText( + bool i_bUseIt ); + virtual bool Add_SpecialMeaningToken( /// @return false, if token was not spüecial. + const char * i_sText, + intt i_nNr ) = 0; + virtual void Add_Token( + const char * i_sText ); + virtual void Add_PotentialLink( + const char * i_sText, + bool i_bIsGlobal, + bool i_bIsFunction ); + virtual void Add_Whitespace( + UINT8 i_nLength ); + virtual void Add_Eol(); + + virtual UINT8 NrOfSpecialMeaningTokens() const = 0; + virtual AtTag * GetFollower() = 0; + + void StoreAt( + DocuDisplay & o_rDisplay ) const; + const DocuText & CText() const; + + private: + virtual void do_StoreAt( + DocuDisplay & o_rDisplay ) const; // later becoming abstract + + virtual DocuText * Text() = 0; +}; + + + +// IMPLEMENTATION + +inline void +AtTag::StoreAt( DocuDisplay & o_rDisplay ) const + { do_StoreAt(o_rDisplay); } +inline const DocuText & +AtTag::CText() const + { DocuText * ret = const_cast< AtTag* >(this)->Text(); + csv_assert( ret != 0 ); + return *ret; + } + + +} +} + +#endif + diff --git a/autodoc/inc/ary/info/ci_text.hxx b/autodoc/inc/ary/info/ci_text.hxx new file mode 100644 index 000000000000..c2dce2bfd11a --- /dev/null +++ b/autodoc/inc/ary/info/ci_text.hxx @@ -0,0 +1,85 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef ARY_INFO_CI_TEXT_HXX +#define ARY_INFO_CI_TEXT_HXX + + + +// USED SERVICES + // BASE CLASSES + // COMPONENTS + // PARAMETERS + + +namespace ary +{ +namespace info +{ + +class DocuToken; +class DocuDisplay; + + +class DocuText +{ + public: + typedef std::vector< DocuToken * > TokenList; + + DocuText(); + ~DocuText(); + + void Set_HtmlUse( + bool i_bUseIt ) + { bUsesHtml = i_bUseIt; } + void Add_Token( + DYN DocuToken & let_drToken ) + { aTokens.push_back(&let_drToken); } + const TokenList & Tokens() const { return aTokens; } + void StoreAt( + DocuDisplay & o_rDisplay ) const; + bool IsNoHtml() const { return NOT bUsesHtml; } + bool IsEmpty() const { return aTokens.size() == 0; } + + private: + TokenList aTokens; + bool bUsesHtml; +}; + + + + + + +// IMPLEMENTATION + + +} +} + +#endif + diff --git a/autodoc/inc/ary/info/docstore.hxx b/autodoc/inc/ary/info/docstore.hxx new file mode 100644 index 000000000000..421904ab94fd --- /dev/null +++ b/autodoc/inc/ary/info/docstore.hxx @@ -0,0 +1,116 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef ARY_INFO_DOCSTORE_HXX +#define ARY_INFO_DOCSTORE_HXX + + + +// USED SERVICES + // BASE CLASSES + // COMPONENTS + // PARAMETERS +#include <ary/info/inftypes.hxx> + +namespace ary +{ +namespace doc +{ + class Node; +} + + + +namespace info +{ + +class DocuStore +{ + public: + virtual ~DocuStore() {} + + void Store2CurFile( + DYN doc::Node & let_drDocu ); + void Store2CurNamespace( + DYN doc::Node & let_drDocu ); + + void Store2ConnectedDeclaration( + DYN doc::Node & let_drDocu ); + + void Store2Glossary( + DYN doc::Node & let_drDocu, + const String & i_sExplainedTerm ); + void Store2GlobalTexts( + DYN doc::Node & let_drDocu, + ary::info::GlobalTextId + i_nId ); + private: + virtual void do_Store2CurFile( + DYN doc::Node & let_drDocu ) = 0; + virtual void do_Store2CurNamespace( + DYN doc::Node & let_drDocu ) = 0; + + virtual void do_Store2ConnectedDeclaration( + DYN doc::Node & let_drDocu ) = 0; + + virtual void do_Store2Glossary( + DYN doc::Node & let_drDocu, + const String & i_sExplainedTerm ) = 0; + virtual void do_Store2GlobalTexts( + DYN doc::Node & let_drDocu, + ary::info::GlobalTextId + i_nId ) = 0; +}; + + + + +// IMPLEMENTATION +inline void +DocuStore::Store2CurFile( DYN doc::Node & let_drDocu ) + { do_Store2CurFile(let_drDocu); } +inline void +DocuStore::Store2CurNamespace( DYN doc::Node & let_drDocu ) + { do_Store2CurNamespace(let_drDocu); } +inline void +DocuStore::Store2ConnectedDeclaration( DYN doc::Node & let_drDocu ) + { do_Store2ConnectedDeclaration(let_drDocu); } +inline void +DocuStore::Store2Glossary( DYN doc::Node & let_drDocu, + const String & i_sExplainedTerm ) + { do_Store2Glossary(let_drDocu, i_sExplainedTerm); } +inline void +DocuStore::Store2GlobalTexts( DYN doc::Node & let_drDocu, + ary::info::GlobalTextId i_nId ) + { do_Store2GlobalTexts(let_drDocu, i_nId); } + + + + +} // namespace info +} // namespace ary +#endif diff --git a/autodoc/inc/ary/info/infodisp.hxx b/autodoc/inc/ary/info/infodisp.hxx new file mode 100644 index 000000000000..f486a2292f8d --- /dev/null +++ b/autodoc/inc/ary/info/infodisp.hxx @@ -0,0 +1,114 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef ARY_INFO_INFODISP_HXX +#define ARY_INFO_INFODISP_HXX +// KORR_DEPRECATED_3.0 + +// BASE CLASSES +// USED SERVICES + + + + +namespace ary +{ +namespace info +{ + class StdTag; + class BaseTag; + class ExceptionTag; + class ImplementsTag; + class KeywordTag; + class ParameterTag; + class SeeTag; + class TemplateTag; + class LabelTag; + class SinceTag; + class DT_Text; + class DT_MaybeLink; + class DT_Whitespace; + class DT_Eol; + class DT_Xml; + + + +/** Displaying an ary::doc::OldCppDocu. + + @descr + This class is an interface, but the functions are defaulted, + to do nothing. so a derived class needn't implement all of them. +*/ +class DocuDisplay +{ + public: + virtual ~DocuDisplay() {} + + virtual void Display_StdTag( + const StdTag & i_rData ) = 0; + virtual void Display_BaseTag( + const BaseTag & i_rData ) = 0; + virtual void Display_ExceptionTag( + const ExceptionTag & + i_rData ) = 0; + virtual void Display_ImplementsTag( + const ImplementsTag & + i_rData ) = 0; + virtual void Display_KeywordTag( + const KeywordTag & i_rData ) = 0; + virtual void Display_ParameterTag( + const ParameterTag & + i_rData ) = 0; + virtual void Display_SeeTag( + const SeeTag & i_rData ) = 0; + virtual void Display_TemplateTag( + const TemplateTag & i_rData ) = 0; + virtual void Display_LabelTag( + const LabelTag & i_rData ) = 0; + virtual void Display_SinceTag( + const ary::info::SinceTag & + i_rData ) = 0; + virtual void Display_DT_Text( + const DT_Text & i_rData ) = 0; + virtual void Display_DT_MaybeLink( + const DT_MaybeLink& i_rData ) = 0; + virtual void Display_DT_Whitespace( + const DT_Whitespace & + i_rData ) = 0; + virtual void Display_DT_Eol( + const DT_Eol & i_rData ) = 0; + virtual void Display_DT_Xml( + const ary::info::DT_Xml & + i_rData ) = 0; +}; + + + + +} +} +#endif diff --git a/autodoc/inc/ary/info/inftypes.hxx b/autodoc/inc/ary/info/inftypes.hxx new file mode 100644 index 000000000000..0bf330670063 --- /dev/null +++ b/autodoc/inc/ary/info/inftypes.hxx @@ -0,0 +1,122 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef ARY_INFO_INFTYPES_HXX +#define ARY_INFO_INFTYPES_HXX + + +// USED SERVICES + // BASE CLASSES + // COMPONENTS + // PARAMETERS + + +namespace ary +{ +namespace info +{ + + + + +typedef uintt GlobalTextId; + + + +/** Because this enum is used as index list for displayed + tag headlines, the items must neither be moved nor deleted. + Only adding to the end is allowed. atid_MAX always has to exist + and to be the last used value. + Also assigning numbers to the values is forbidden. +*/ +enum E_AtTagId +{ + atid_ATT = 0, + atid_author, + atid_change, + atid_collab, + atid_contact, + + atid_copyright, + atid_deprecated, + atid_descr, + atid_docdate, + atid_derive, + + atid_dyn, + atid_instance, + atid_interface, + atid_invariant, + atid_life, + + atid_multi, + atid_onerror, + atid_persist, + atid_postcond, + atid_precond, + + atid_resp, + atid_return, + atid_short, + atid_todo, + atid_version, + + atid_MAX +}; + +/** Because this enum is used as index list for displayed + tag headlines, the items must neither be moved nor deleted. + Only adding to the end is allowed. C_eAtTag_NrOfClasses always has to exist + and to be the last used value. + Also assigning other numbers to the values, than in this + existing scheme, is forbidden. +*/ +enum E_AtTagClass +{ + atc_std = 0, + + atc_base = atid_MAX, + atc_exception = atid_MAX + 1, + atc_implements = atid_MAX + 2, + atc_keyword = atid_MAX + 3, + atc_parameter = atid_MAX + 4, + + atc_see = atid_MAX + 5, + atc_template = atid_MAX + 6, + atc_label = atid_MAX + 7, + atc_since = atid_MAX + 8, + C_eAtTag_NrOfClasses +}; + + + +} // namespace info +} // namespace ary + + +#endif + |