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

« back to all changes in this revision

Viewing changes to Puma/gen-release/step1/inc/Puma/CCandidateInfo.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 __CCandidateInfo_h__
20
20
#define __CCandidateInfo_h__
21
21
 
 
22
/** \internal Internal part of the overload resolution mechanism. */
 
23
 
 
24
/** \file 
 
25
 *  Representation of a C++ overload resolution candidate. */
 
26
 
22
27
#include "Puma/CCConvSeq.h"
23
28
#include "Puma/Array.h"
24
29
 
26
31
 
27
32
class CFunctionInfo;
28
33
 
29
 
/** \internal Internal part of the overload resolution mechanism. */
30
 
 
31
 
/** \file 
32
 
 *  Representation of a C++ overload resolution candidate. 
33
 
 *  \see Puma::CCandidateInfo */
34
 
 
35
 
/** \class CCandidateInfo CCandidateInfo.h Puma/infos/CCandidateInfo.h
36
 
 *  A CCandidateInfo object represents a candidate for the C++
37
 
 *  function overload resolution mechanism. Such a candidate stores 
38
 
 *  the candidate function and the conversion sequences of the function
39
 
 *  call arguments needed to match the function parameter types. */
 
34
/** \class CCandidateInfo CCandidateInfo.h Puma/CCandidateInfo.h
 
35
 *  Representation of a candidate for the C++ function overload 
 
36
 *  resolution mechanism. Such a candidate stores the candidate 
 
37
 *  function and the conversion sequences of the function call 
 
38
 *  arguments needed to match the function parameter types of
 
39
 *  the overloaded function. */
40
40
class CCandidateInfo {
41
41
  Array<CCConvSeq*> _ConvSequences;
42
42
  CFunctionInfo *_Function;
43
43
  CCConvSeq *_SecondConvSeq;
44
44
 
45
45
public: 
46
 
  /** Construct a new candidate info.
47
 
   *  \param fi The function info of the candidate. */
 
46
  /** Constructor.
 
47
   *  \param fi The candidate function. */
48
48
  CCandidateInfo (CFunctionInfo *fi);
49
 
  /** Destruct the candidate info. */
 
49
  /** Destructor. */
50
50
  ~CCandidateInfo ();
51
51
 
52
52
  /** Get the candidate function. */
53
53
  CFunctionInfo *Function () const;
54
54
  /** Set the candidate function. 
55
 
   *  \param fi The candidate function info. */
 
55
   *  \param fi The candidate function. */
56
56
  void Function (CFunctionInfo *fi);
57
57
  
58
 
  /** Add a conversion sequence for an argument. The conversion
59
 
   *  sequences are added in the order of the argument of the
60
 
   *  function call.
 
58
  /** Add a conversion sequence for a function argument. 
 
59
   *  The conversion sequences are added in the order of 
 
60
   *  the arguments of the function call.
61
61
   *  \param seq The conversion sequence. */
62
62
  void addConvSequence (CCConvSeq *seq);
63
63
  
65
65
  unsigned ConvSequences () const;
66
66
  /** Get the n-th conversion sequence. The n-th conversion sequence 
67
67
   *  corresponds to the n-th function call argument. 
68
 
   *  \param n The conversion sequence or \c NULL if \e n is invalid. */
 
68
   *  \param n The conversion sequence or NULL if \e n is invalid. */
69
69
  CCConvSeq *ConvSequence (unsigned n);
70
70
  
71
71
  /** Set the \e second conversion sequence. This is a user-defined
72
72
   *  conversion by means of a user-defined conversion function. 
73
73
   *  \param seq The conversion sequence. */
74
74
  void SecondConvSeq (CCConvSeq *seq);
75
 
  /** Set the \e second conversion sequence. */
 
75
  /** Get the \e second conversion sequence. */
76
76
  CCConvSeq *SecondConvSeq () const;
77
77
};
78
78