blob: 8ed40eca35252bc29987372f70ba90709c439d8a [file] [log] [blame]
/**************************************************************
*
* 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
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*************************************************************/
#ifndef ADC_DISPLAY_ARYATTRS_HXX
#define ADC_DISPLAY_ARYATTRS_HXX
// USED SERVICES
#include <ary/cpp/c_types4cpp.hxx>
#include <ary/doc/d_docu.hxx>
#include <ary/doc/d_oldcppdocu.hxx>
namespace ary
{
namespace cpp
{
class CodeEntity;
class Class;
class DisplayGate;
class Function;
class Namespace;
}
}
const char * Get_ClassTypeKey(
const ary::cpp::Class & i_rClass );
const char * Get_TypeKey(
const ary::cpp::CodeEntity &
i_rCe );
bool Ce_IsInternal(
const ary::cpp::CodeEntity &
i_rCe );
const char * SyntaxText_PreName(
const ary::cpp::Function &
i_rFunction,
const ary::cpp::Gate & i_rAryGate );
const char * SyntaxText_PostName(
const ary::cpp::Function &
i_rFunction,
const ary::cpp::Gate & i_rAryGate );
bool Get_TypeText(
const char * & o_rPreName,
const char * & o_rName,
const char * & o_rPostName,
ary::cpp::Type_id i_nTypeid,
const ary::cpp::Gate & i_rAryGate );
inline const ary::doc::OldCppDocu *
Get_CppDocu(const ary::doc::Documentation & i_doc)
{
return dynamic_cast< const ary::doc::OldCppDocu* >(i_doc.Data());
}
class FunctionParam_Iterator
{
public:
FunctionParam_Iterator();
~FunctionParam_Iterator();
operator bool() const;
FunctionParam_Iterator &
operator++();
void Assign(
const ary::cpp::Function &
i_rFunction );
ary::cpp::Type_id
CurType() const;
const String & CurName() const;
bool IsFunctionConst() const;
bool IsFunctionVolatile() const;
private:
typedef std::vector<ary::cpp::Type_id>::const_iterator Type_Iterator;
typedef StringVector::const_iterator Name_Iterator;
bool IsValid() const;
// Forbidden
FunctionParam_Iterator &
operator++(int);
// DATA
Type_Iterator itTypes;
Type_Iterator itTypes_end;
Name_Iterator itNames_andMore; /// Name, init-value.
Name_Iterator itNames_andMore_end;
ary::cpp::E_ConVol eConVol;
};
// IMPLEMENTATION
inline
FunctionParam_Iterator::operator bool() const
{ return IsValid(); }
inline bool
FunctionParam_Iterator::IsValid() const
{
// By C'tor and Assign(), it is assured, that
// both iterators are valid, if one is valid.
return itTypes != itTypes_end;
}
inline ary::cpp::Type_id
FunctionParam_Iterator::CurType() const
{ return IsValid() ? *itTypes : ary::cpp::Type_id(0); }
inline const String &
FunctionParam_Iterator::CurName() const
{ return IsValid() ? *itNames_andMore : String::Null_(); }
inline bool
FunctionParam_Iterator::IsFunctionConst() const
{ return (eConVol & ary::cpp::CONVOL_const) != 0; }
inline bool
FunctionParam_Iterator::IsFunctionVolatile() const
{ return (eConVol & ary::cpp::CONVOL_volatile) != 0; }
#endif