annotations.h File Reference

#include "../Versioned_Namespace.h"
#include <ast_expression.h>
#include <ace/Basic_Types.h>
#include <vector>
#include <string>
#include <map>
#include <set>

Include dependency graph for annotations.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	Annotations
class	Annotation
class	AbsentValue< T >
class	AnnotationWithValue< T >
class	AnnotationWithEnumValue< T >
class	KeyAnnotation
struct	TopicValue
class	TopicAnnotation
class	NestedAnnotation
class	DefaultNestedAnnotation
class	IdAnnotation
class	AutoidAnnotation
class	HashidAnnotation
class	OptionalAnnotation
class	MustUnderstandAnnotation
class	ExternalAnnotation
class	ExtensibilityAnnotation
class	FinalAnnotation
class	AppendableAnnotation
class	MutableAnnotation
class	TryConstructAnnotation
struct	OpenDDS::DataRepresentation
class	OpenDDS::DataRepresentationAnnotation
struct	OpenDDS::internal::NoDynamicDataAdapterAnnotation
class	OpenDDS::internal::SpecialSerializationAnnotation

Namespaces
	OpenDDS
	The Internal API and Implementation of OpenDDS.
	OpenDDS::internal

Enumerations
enum	AutoidKind { autoidkind_sequential, autoidkind_hash }
enum	ExtensibilityKind { extensibilitykind_final, extensibilitykind_appendable, extensibilitykind_mutable }
enum	TryConstructFailAction { tryconstructfailaction_discard, tryconstructfailaction_use_default, tryconstructfailaction_trim }

Functions
AST_Expression::AST_ExprValue *	get_annotation_member_ev (AST_Annotation_Appl *appl, const char *member_name, AST_Expression::ExprType type)
bool	get_bool_annotation_member_value (AST_Annotation_Appl *appl, const char *member_name)
ACE_UINT32	get_u32_annotation_member_value (AST_Annotation_Appl *appl, const char *member_name)
std::string	get_str_annotation_member_value (AST_Annotation_Appl *appl, const char *member_name)

Enumeration Type Documentation

AutoidKind

enum AutoidKind

Enumerator
autoidkind_sequential
autoidkind_hash

Definition at line 217 of file annotations.h.

                {
  autoidkind_sequential,
  autoidkind_hash
};

ExtensibilityKind

enum ExtensibilityKind

Enumerator
extensibilitykind_final
extensibilitykind_appendable
extensibilitykind_mutable

Definition at line 278 of file annotations.h.

                       {
  extensibilitykind_final,
  extensibilitykind_appendable,
  extensibilitykind_mutable
};

TryConstructFailAction

enum TryConstructFailAction

Enumerator
tryconstructfailaction_discard
tryconstructfailaction_use_default
tryconstructfailaction_trim

Definition at line 316 of file annotations.h.

                            {
  tryconstructfailaction_discard,
  tryconstructfailaction_use_default,
  tryconstructfailaction_trim,
};

Function Documentation

get_annotation_member_ev()

AST_Expression::AST_ExprValue* get_annotation_member_ev	(	AST_Annotation_Appl *	appl,
		const char *	member_name,
		AST_Expression::ExprType	type
	)

Definition at line 93 of file annotations.cpp.

References be_util::misc_error_and_abort().

Referenced by get_bool_annotation_member_value(), get_str_annotation_member_value(), and get_u32_annotation_member_value().

{
  AST_Annotation_Member* member =
    dynamic_cast<AST_Annotation_Member*>((*appl)[member_name]);
  if (member) {
    AST_Expression* e = member->value();
    if (e && e->ev()) {
      if (e->ev()->et != type) {
        be_util::misc_error_and_abort(std::string("Found unexpected expression type "
                                      "while getting value of member \"") +
                                      member_name + "\" of annotation \"" +
                                      appl->local_name()->get_string() + '"',
                                      appl);
      }
      return e->ev();
    }
  }

  be_util::misc_error_and_abort(std::string("Found null pointer while getting value of member \"") +
                                member_name + "\" of annotation \"" +
                                appl->local_name()->get_string() + '"',
                                appl);
  return 0;
}

get_bool_annotation_member_value()

bool get_bool_annotation_member_value	(	AST_Annotation_Appl *	appl,
		const char *	member_name
	)

Definition at line 119 of file annotations.cpp.

References get_annotation_member_ev().

Referenced by get_str_annotation_member_value().

{
  AST_Expression::AST_ExprValue* const ev =
    get_annotation_member_ev(appl, member_name, AST_Expression::EV_bool);
  return ev->u.bval;
}

get_str_annotation_member_value()

std::string get_str_annotation_member_value	(	AST_Annotation_Appl *	appl,
		const char *	member_name
	)

Definition at line 135 of file annotations.cpp.

References get_annotation_member_ev(), get_bool_annotation_member_value(), get_str_annotation_member_value(), get_u32_annotation_member_value(), and AnnotationWithValue< T >::value_from_appl().

Referenced by get_str_annotation_member_value(), TopicAnnotation::value_from_appl(), and OpenDDS::internal::SpecialSerializationAnnotation::value_from_appl().

{
  AST_Expression::AST_ExprValue* const ev =
    get_annotation_member_ev(appl, member_name, AST_Expression::EV_string);
  return ev->u.strval->get_string();
}

get_u32_annotation_member_value()

ACE_UINT32 get_u32_annotation_member_value	(	AST_Annotation_Appl *	appl,
		const char *	member_name
	)

Definition at line 127 of file annotations.cpp.

References get_annotation_member_ev().

Referenced by get_str_annotation_member_value(), AnnotationWithEnumValue< ExtensibilityKind >::value_from_appl(), and OpenDDS::DataRepresentationAnnotation::value_from_appl().

{
  AST_Expression::AST_ExprValue* const ev =
    get_annotation_member_ev(appl, member_name, AST_Expression::EV_ulong);
  return ev->u.ulval;
}