2005/5/10

     
 

ACDK Metacompiler - Manual

artefaktur

man pages for acdkmc - ACDK Metacompiler


Content of this chapter:

   NAME
   DESCRIPTION
   SYNOPSIS
     Calling acdkmc
     Class format
     Tags
     DMI-Proxies
   FILES
   SEE ALSO



 NAME

acdkmc - ACDK Metacompiler

 DESCRIPTION

acdkmc is the compiler that generates  metainfo for acdk-classes. The metainfo will be used for Garbage Collection, Serialization,  DMI and Middleware support.

 SYNOPSIS

 Calling acdkmc

acdkmc [acdk-options] [acdkmc-options] file or directory
  acdkmc-options:
  -dmiproxy       generate dmiproxy for selected module

acdkmc is the compiler that generates  metainfo and  DMI stubs and proxies for acdk-classes.

If you want to generate metainfo for one namespace/directory:
acdkmc ./src/acdk/text.
acdkmc generates a file named:
./src/acdk/text/text_metainf_base.cpp.
which contains the base metainfo of all header found in this directory.
./src/acdk/text/text_metainf/text_metainf/text_metainf_ext.cpp.
which contains the extended metainfo of all header found in this directory.


 Class format

The ACDK meta compiler is not a strict but a lazy parser.
Therefore, it scans only for class declarations. If acdkmc finds a ACDK_WITH_METAINFO in the header, it will generate meta information for this class.
Only members, methods and constuctors are considered, which contain types known by ACDK:
  • basic types: bool, char, byte, short, int, jlong, float, double
  • Arrays of Basic types: RboolArray, RcharArray, and so on
  • ACDK-Objects, i.e. references to classes and interfaces. RInteger, acdk::util::RIterator
  • enums which are declared (not necessarely defined) in the same header.

Types not known by ACDK:
  • signed/unsigned with integer types
  • other basic types
  • other classes/enums
  • pointer, references
  • const
You can, of course, also use these types as class elements, but acdkmc will not create metainfo for these elements; they are not included in the metafeatures: garbage collection, serialisation, debugging, etc.
Please refer also to http acdk.sourceforge.net for more information.

 Tags

If a member, method, or constructor is marked with the keyword foreign, no class information will be generated for this element.

 DMI-Proxies

about the usage of the option -dmiproxy Please read notes at  Subclassing.

 FILES

bin/acdkmc - The executable

 SEE ALSO


 acdk_core.
 ACDK Metainfo.