diff options
Diffstat (limited to 'autodoc/inc/ary/idl/i_type.hxx')
-rw-r--r-- | autodoc/inc/ary/idl/i_type.hxx | 142 |
1 files changed, 142 insertions, 0 deletions
diff --git a/autodoc/inc/ary/idl/i_type.hxx b/autodoc/inc/ary/idl/i_type.hxx new file mode 100644 index 000000000000..75f9737f1468 --- /dev/null +++ b/autodoc/inc/ary/idl/i_type.hxx @@ -0,0 +1,142 @@ +/************************************************************************* + * + * 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_IDL_I_TYPE_HXX +#define ARY_IDL_I_TYPE_HXX + +// USED SERVICES +#include <ary/entity.hxx> +#include <ary/idl/i_types4idl.hxx> + + + + +namespace ary +{ +namespace idl +{ + class Gate; + + +/** Abstract base for all secondary productions of types +*/ +class Type_2s +{ + public: + virtual ~Type_2s() {} + + static DYN Type_2s * + Create_( + ClassId i_nCeId ); +}; + + +/** Base of all IDL types. + + Type represents the occurence of a type as base, + parameter, return type or element type in UNO IDL code. + Some of them relate to a ->CodeEntity, but + the ->Type "MyInterface" is something different than + the ->CodeEntity "MyInterface". + + This is a storage base class, where more special + classes are derived from. +*/ +class Type : public ary::Entity +{ + public: + typedef Type_2s secondary_productions; + + // LIFECYCLE + virtual ~Type() {} + + // INQUIRY + Type_id TypeId() const { return Type_id(Id()); } + + /** Does NOT clear the output-parameters. + + @attention + If this is a sequence, the text of the first non-sequence, enclosed type + is returned. + */ + void Get_Text( + StringVector & o_module, + String & o_name, + Ce_id & o_nRelatedCe, + int & o_nSequenceCount, + const Gate & i_rGate ) const; + const std::vector<Type_id> * + TemplateParameters() const; + const Type & FirstEnclosedNonSequenceType( /// @return *this, if this is not a ->Sequence. + const Gate & i_rGate ) const; + + private: + virtual void inq_Get_Text( + StringVector & o_module, + String & o_name, + Ce_id & o_nRelatedCe, + int & o_nSequemceCount, + const Gate & i_rGate ) const = 0; + virtual const std::vector<Type_id> * + inq_TemplateParameters() const; + virtual const Type & + inq_FirstEnclosedNonSequenceType( + const Gate & i_rGate ) const; +}; + + + + +// IMPLEMENTATION +inline void +Type::Get_Text( StringVector & o_module, + String & o_name, + Ce_id & o_nRelatedCe, + int & o_nSequenceCount, + const Gate & i_rGate ) const +{ + inq_Get_Text(o_module,o_name,o_nRelatedCe,o_nSequenceCount,i_rGate); +} + +inline const std::vector<Type_id> * +Type::TemplateParameters() const +{ + return inq_TemplateParameters(); +} + +inline const Type & +Type::FirstEnclosedNonSequenceType(const Gate & i_rGate) const +{ + return inq_FirstEnclosedNonSequenceType(i_rGate); +} + + + + +} // namespace idl +} // namespace ary +#endif |