TOC PREV NEXT INDEX DOC LIST MASTER INDEX




Function Enumeration_Representation_Clause_Aggregate

Expanded Name Asis.Representation_Clauses-
.Enumeration_Representation_Clause_Aggregate

Returns the expression representing the enumeration representation associated with the specified clause.

Description

Enumeration representation clauses are defined by the following syntax:

Ada83 LRM 13.3, Ada95 LRM 13.4

 enumeration_representation_clause ::=
  for type_simple_name use aggregate;

This function returns the aggregate for the specified enumeration representation clause.

Parameters

Specifies the enumeration representation clause for which the aggregate expression should be returned. The clause must be of the following kinds:
Element_Kinds
Representation_Clause_Kinds
A_Representation_Clause
An_Enumeration_Representation_Clause

Element_Kinds
Expression_Kinds
An_Expression
An_Aggregate
The returned element is of the following kinds:

Errors

Asis_Inappropriate_Element is raised and Environment.Status is set to Value_Error if a parameter references a Library variable that is no longer open or a parameter is specified that is not appropriate for the query.

Examples

Cross-References

Related subprograms:

Related concepts:


Function Enumeration_Representation_Clause_Type_Simple_Name

Expanded Name Asis.Representation_Clauses-
.Enumeration_Representation_Clause_Type_Simple-
_Name

Returns the simple name associated with the specified enumeration representation clause.

Description

Enumeration representation clauses are defined by the following syntax:

Ada83 LRM 13.3, Ada95 LRM 13.4

 enumeration_representation_clause ::=
  for type_simple_name use aggregate;

This function returns the type simple name for the specified enumeration representation clause.

Parameters

Specifies the record representation clause for which the simple name should be returned. The clause must be of the following kinds:
Element_Kinds
Representation_Clause_Kinds
A_Representation_Clause
A_Record_Representation_Clause

Element_Kinds
Expression_Kinds
An_Expression
A_Simple_Name
The returned element is of the following kinds:

Errors

Asis_Inappropriate_Element is raised and Environment.Status is set to Value_Error if a parameter references a Library variable that is no longer open or a parameter is specified that is not appropriate for the query.

Examples

Cross-References

Related subprograms:

Related concepts:


Function Kind

Expanded Name Asis.Representation_Clauses.Kind

Returns the kind of representation clause associated with the specified clause.

Description

Representation clauses are defined by the following syntax:

Ada83 LRM 13.1, Ada95 LRM 13.1 

representation_clause ::=
  type_representation_clause | address_clause

 type_representation_clause ::= length_clause
  | enumeration_representation_clause
  | record_representation_clause

This function returns the kind of the specified representation clause.

If the specified clause is not a representation specification or is Asis.Nil_Element, Not_A_Representation_Clause is returned.

A_Representation_Clause elements are returned in a Declarative_Item_List by the following functions:

Parameters

Specifies the representation clause for which the kind should be returned. The clause must be of the following kind:
Element_Kinds
A_Representation_Clause

Returns the kind of the representation represented by the clause or Not_A_Representation if the clause is not a representation clause or is Asis.Nil_Element.

Errors

Asis_Inappropriate_Element is raised and Environment.Status is set to Value_Error if a parameter references a Library variable that is no longer open or a parameter is specified that is not appropriate for the query.

Examples

Cross-References

Related subprograms and types:

Related concepts:


Function Length_Clause_Attribute

Expanded Name Asis.Representation_Clauses.Length_Clause_Attribute

Returns the length expression associated with the specified representation clause.

Description

Length clauses are defined by the following syntax:

Ada83 LRM 13.2, Ada95 LRM 13.3
 length_clause ::=
  for attribute use simple_expression;

This function returns the attribute for the specified length clause.

Parameters

Specifies the length representation clause for which the length should be returned. The clause must be of the following kinds:
Element_Kinds
Representation_Clause_Kinds
A_Representation_Clause
A_Length_Clause

The returned element is of the following kinds:
Element_Kinds
Expression_Kinds
An_Expression
An_Attribute

Errors

Asis_Inappropriate_Element is raised and Environment.Status is set to Value_Error if a parameter references a Library variable that is no longer open or a parameter is specified that is not appropriate for the query.

Examples

Cross-References

Related subprograms:

Related concepts:


Function Length_Clause_Attribute_Kind

Expanded Name Asis.Representation_Clauses-
.Length_Clause_Attribute_Kind

Returns the kind of length clause represented by the specified representation clause.

Description

Length clauses are defined by the following syntax:

Ada83 LRM 13.2, Ada95 LRM 13.3
 length_clause ::=
  for attribute use simple_expression;

Ada83 LRM 4.1.4, Ada95 LRM 4.1.4 
attribute ::= prefix'attribute_designator

This function returns the kind of attribute designator for the specified length clause.

If the specified clause does not represent a length clause, Not_A_Length_Clause is returned.

Parameters

Specifies the length representation clause for which the list of associated length attributes should be returned. The clause must be of the following kinds:
Element_Kinds
Representation_Clause_Kinds
A_Representation_Clause
A_Length_Clause

Returns the kind of length clauses associated with the specified clause or Not_A_Length_Clause for all other elements.

Errors

Asis_Inappropriate_Element is raised and Environment.Status is set to Value_Error if a parameter references a Library variable that is no longer open or a parameter is specified that is not appropriate for the query.

Examples

Cross-References

Related subprograms and types:

Related concepts:


Type Length_Clause_Attribute_Kinds

Expanded Name Asis.Representation_Clauses-
.Length_Clause_Attribute_Kinds

Describes the kinds of length clauses that are available.

Description

This type describes the kinds of length clauses that are
available.

Enumerations

Indicates that a clause is a collection storage-size attribute ('Storage_Size, Ada83 LRM 13.2(7), Ada95 LRM 13.3).

Indicates that a clause is a size attribute ('Size, Ada83 LRM 13.2(4), Ada95 LRM 13.3).

Indicates that a clause is a fixed-point small attribute declaration ('Small, Ada83 LRM 13.2(11), Ada95 LRM 13.3).

Indicates that a clause is a task storage-size attribute ('Storage-
_Size, Ada83 LRM 13.2(9), Ada95 LRM 13.3).

Indicates that a clause does not represent an attribute definition.

Cross-References

Related subprogram:

Related concept:


Function Length_Clause_Simple_Expression

Expanded Name Asis.Representation_Clauses-
.Length_Clause_Simple_Expression

Returns the length expression associated with the specified representation clause.

Description

Length clauses are defined by the following syntax:

Ada83 LRM 13.2, Ada95 LRM 13.3 

length_clause ::=
  for attribute use simple_expression;

This function returns the simple expression for the specified length clause.

Parameters

Specifies the length representation clause for which the length expression should be returned. The clause must be of the following kinds:
Element_Kinds
Representation_Clause_Kinds
A_Representation_Clause
A_Length_Clause

Element_Kinds

An_Expression

The returned element is of the following kind:

Errors

Asis_Inappropriate_Element is raised and Environment.Status is set to Value_Error if a parameter references a Library variable that is no longer open or a parameter is specified that is not appropriate for the query.

Examples

Cross-References

Related subprograms:

Related concepts:


Function Record_Representation_Clause_Alignment_Clause_Expression

Expanded Name Asis.Representation_Clauses-
.Record_Representation_Clause_Alignment_Clause-
_Expression

Returns the alignment clause expression associated with the specified representation clause.

Description

Record representation clauses are partially defined by the following syntax:

Ada83 LRM 13.4, Ada95 LRM 13.5.1 

record_representation_clause ::=
  for type_simple_name use
   record [alignment_clause]
    {component_clause}
   end record;

 alignment_clause ::=
  at mod static_simple_expression;

This function returns the static simple expression for the specified record representation clause.

If the record representation clause does not include an at mod component, Asis.Nil_Element is returned.

If the record is discriminated, several of the static simple expressions can evaluate to the same value.

Parameters

Specifies the record representation clause for which the alignment clause expression should be returned. The clause must be of the following kinds:
Element_Kinds
Representation_Clause_Kinds
A_Representation_Clause
A_Record_Representation_Clause

Element_Kinds

An_Expression

The returned element is of the following kind:

Errors

Asis_Inappropriate_Element is raised and Environment.Status is set to Value_Error if a parameter references a Library variable that is no longer open or a parameter is specified that is not appropriate for the query.

Examples

Cross-References

Related subprograms:

Related concepts:


Function Record_Representation_Clause_Alignment_Clause_Pragmas

Expanded Name Asis.Representation_Clauses-
.Record_Representation_Clause_Alignment_Clause-
_Pragmas

Returns a list of the pragmas that preceded the reserved words (or in place of) at mod that begin the alignment expression for the specified record representation clause.

Description

Record representation clauses are partially defined by the following syntax:

Ada83 LRM 13.4, Ada95 LRM 13.5.1

 record_representation_clause ::=
  for type_simple_name use
   record [alignment_clause]
    {component_clause}
   end record;

 alignment_clause ::=
  at mod static_simple_expression;

Because of the Ada definition, it is possible to include a pragma before or in place of the at mod clause. This function returns the pragmas defined at that location.

If no pragmas appear before or in place of the alignment clause, Asis.Nil_Element_List is returned.

Parameters

Specifies the record representation clause for which the alignment pragmas should be returned. The clause must be of the following kinds:
Element_Kinds
Representation_Clause_Kinds
A_Representation_Clause
A_Record_Representation_Clause

The returned list contains elements of the following kind:
Element_Kinds

A_Pragma

Errors

Asis_Inappropriate_Element is raised and Environment.Status is set to Value_Error if a parameter references a Library variable that is no longer open or a parameter is specified that is not appropriate for the query.

Examples

Cross-References

Related subprograms:

Related concepts:


Function Record_Representation_Clause_Type_Simple_Name

Expanded Name Asis.Representation_Clauses-
.Record_Representation_Clause_Type_Simple_Name

Returns the simple name associated with the specified record representation clause.

Description

Record representation clauses are  partially defined by the following syntax:

Ada83 LRM 13.4, Ada95 LRM 13.5.1

 record_representation_clause ::=
  for type_simple_name use
   record [alignment_clause]
    {component_clause}
   end record;

This function returns the type simple name from the specified record representation clause.

Parameters

Specifies the record representation clause for which the simple name should be returned. The clause must be of the following kinds:
Element_Kinds
Representation_Clause_Kinds
A_Representation_Clause
A_Record_Representation_Clause

Element_Kinds
Expression_Kinds
An_Expression
A_Simple_Name
The returned element is of the following kinds:

Errors

Asis_Inappropriate_Element is raised and Environment.Status is set to Value_Error if a parameter references a Library variable that is no longer open or a parameter is specified that is not appropriate for the query.

Examples

Cross-References

Related subprograms:

Related concepts:


Type Representation_Clause_Kinds

Expanded Name Asis.Representation_Clauses-
.Representation_Clause_Kinds

Describes the kinds of representation clauses that are available.

Description

This type describes the kinds of representation clauses that are available.

Enumerations

Indicates that the element represents an address clause (Ada83 LRM 13.5, Ada95 LRM 13.3).

Indicates that the element represents an enumeration representation clause (Ada83 LRM 13.3, Ada95 LRM 13.4).

Indicates that the element represents a length clause (Ada83 LRM 13.2, Ada95 LRM 13.3).

Indicates that the element represents a record representation clause (Ada83 LRM 13.4, Ada95 LRM 13.5.1).

Indicates that the element does not represents a representation clause.

Cross-References

Related subprogram:

Related concept:


Package Operations

Expanded Name Asis.Representation_Clauses.Operations

Package Operations provides a simple way to obtain visibility to operators for types used in package Representation_Clauses. The package typically is referenced in a use clause by an
application.

Cross-References

Related subprograms and types:

Related concepts:


Rational Software Corporation  http://www.rational.com
support@rational.com
techpubs@rational.com
Copyright © 1993-2001, Rational Software Corporation. All rights reserved.
TOC PREV NEXT INDEX DOC LIST MASTER INDEX TECHNOTES APEX TIPS