~ubuntu-branches/ubuntu/jaunty/aspectc++/jaunty

« back to all changes in this revision

Viewing changes to Puma/src/infos/CFileInfo.h

  • Committer: Bazaar Package Importer
  • Author(s): Reinhard Tartler
  • Date: 2008-07-07 14:41:02 UTC
  • mfrom: (1.1.3 upstream) (6.1.1 lenny)
  • Revision ID: james.westby@ubuntu.com-20080707144102-lzml7t07f3sl00r5
Tags: 1.0pre4~svn.20080711-1
* new upstream snapshot.
* include all upstream documentation. Clarifying emails regarding
  licensing has been included into debian/copyright.
* reformat description following recomendations of
  http://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Description
  (Closes: #480316)

Show diffs side-by-side

added added

removed removed

Lines of Context:
19
19
#ifndef __CFileInfo_h__
20
20
#define __CFileInfo_h__
21
21
 
22
 
// source file info
23
 
// knows the token unit it is representing
 
22
/** \file 
 
23
 *  Semantic information about a source file (translation unit). */
24
24
 
25
25
#include "Puma/CNamespaceInfo.h"
26
26
 
29
29
 
30
30
class Unit;
31
31
 
32
 
/** \file 
33
 
 *  Representation of a C/C++ source file.
34
 
 *  \see Puma::CFileInfo */
35
 
 
36
 
/** \class CFileInfo CFileInfo.h Puma/infos/CFileInfo.h
37
 
 *  A CFileInfo object represents a C/C++ source file. A source 
38
 
 *  file also is a scope, i.e. the file scope. */
 
32
/** \class CFileInfo CFileInfo.h Puma/CFileInfo.h
 
33
 *  Semantic information about a source file (translation unit). 
 
34
 *  A source file has its own scope, the so-called file scope. */
39
35
class CFileInfo : public CNamespaceInfo {
40
36
  Unit *_Primary;
41
37
  bool _haveCBuiltins;
42
38
  bool _haveCCBuiltins;
43
39
 
44
40
public: 
45
 
  /** Constructs a new file info. */
 
41
  /** Constructor. */
46
42
  CFileInfo ();
47
 
  /** Destructs the file info. If the object id is 
48
 
   *  \c FILE_INFO, Puma::CObjectInfo::CleanUp() is called. */
 
43
  /** Destructor. If the object type is CObjectInfo::FILE_INFO, 
 
44
   *  then CObjectInfo::CleanUp() is called. */
49
45
  ~CFileInfo ();
50
46
 
51
 
  /** Get the token unit of the source file. */
 
47
  /** Get the token chain of the source file. */
52
48
  Unit *Primary () const;
53
 
  /** Set the token unit of the source file.
54
 
   *  \param unit The token unit. */
 
49
  /** Set the token chain of the source file.
 
50
   *  \param unit The token chain. */
55
51
  void Primary (Unit *unit);
56
52
  
57
 
  /** Return \e true if C compiler build-in functions are defined 
 
53
  /** Check if C compiler build-in functions are defined
58
54
   *  for the source file. */
59
55
  bool haveCBuiltins () const;
60
 
  /** Return \e true if C++ compiler build-in functions are defined 
 
56
  /** Check if C++ compiler build-in functions are defined 
61
57
   *  for the source file. */
62
58
  bool haveCCBuiltins () const;
63
59