code fragment storage initial check-in.
[people/mcb30/basetools.git] / Source / Python / Ecc / CodeFragment.py
1 ## @file\r
2 # fragments of source file\r
3 #\r
4 #  Copyright (c) 2007, Intel Corporation\r
5 #\r
6 #  All rights reserved. This program and the accompanying materials\r
7 #  are licensed and made available under the terms and conditions of the BSD License\r
8 #  which accompanies this distribution.  The full text of the license may be found at\r
9 #  http://opensource.org/licenses/bsd-license.php\r
10 #\r
11 #  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12 #  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13 #\r
14 \r
15 \r
16 ## The description of comment contents and start & end position\r
17 #\r
18 #\r
19 class Comment :\r
20     ## The constructor\r
21     #\r
22     #   @param  self        The object pointer\r
23     #   @param  Str         The message to record\r
24     #   @param  Begin       The start position tuple.\r
25     #   @param  End         The end position tuple.\r
26     #   @param  CommentType The type of comment (T_COMMENT_TWO_SLASH or T_COMMENT_SLASH_STAR).\r
27     #\r
28     def __init__(self, Str, Begin, End, CommentType):\r
29         self.Content = Str\r
30         self.StartPos = Begin\r
31         self.EndPos = End\r
32         self.Type = CommentType\r
33 \r
34 ## The description of preprocess directives and start & end position\r
35 #\r
36 #\r
37 class PP_Directive :\r
38     ## The constructor\r
39     #\r
40     #   @param  self        The object pointer\r
41     #   @param  Str         The message to record\r
42     #   @param  Begin       The start position tuple.\r
43     #   @param  End         The end position tuple.\r
44     #\r
45     def __init__(self, Str, Begin, End):\r
46         self.Content = Str\r
47         self.StartPos = Begin\r
48         self.EndPos = End\r
49 \r
50 ## The description of predicate expression and start & end position\r
51 #\r
52 #\r
53 class PredicateExpression :\r
54     ## The constructor\r
55     #\r
56     #   @param  self        The object pointer\r
57     #   @param  Str         The message to record\r
58     #   @param  Begin       The start position tuple.\r
59     #   @param  End         The end position tuple.\r
60     #\r
61     def __init__(self, Str, Begin, End):\r
62         self.Content = Str\r
63         self.StartPos = Begin\r
64         self.EndPos = End\r
65 \r
66 ## The description of function definition and start & end position\r
67 #\r
68 #\r
69 class FunctionDefinition :\r
70     ## The constructor\r
71     #\r
72     #   @param  self        The object pointer\r
73     #   @param  Str         The message to record\r
74     #   @param  Begin       The start position tuple.\r
75     #   @param  End         The end position tuple.\r
76     #\r
77     def __init__(self, ModifierStr, DeclStr, Begin, End):\r
78         self.Modifier = ModifierStr\r
79         self.Declarator = DeclStr\r
80         self.StartPos = Begin\r
81         self.EndPos = End\r
82 \r
83 ## The description of variable declaration and start & end position\r
84 #\r
85 #\r
86 class VariableDeclaration :\r
87     ## The constructor\r
88     #\r
89     #   @param  self        The object pointer\r
90     #   @param  Str         The message to record\r
91     #   @param  Begin       The start position tuple.\r
92     #   @param  End         The end position tuple.\r
93     #\r
94     def __init__(self, ModifierStr, DeclStr, Begin, End):\r
95         self.Modifier = ModifierStr\r
96         self.Declarator = DeclStr\r
97         self.StartPos = Begin\r
98         self.EndPos = End\r
99 \r
100 ## The description of enum definition and start & end position\r
101 #\r
102 #\r
103 class EnumerationDefinition :\r
104     ## The constructor\r
105     #\r
106     #   @param  self        The object pointer\r
107     #   @param  Str         The message to record\r
108     #   @param  Begin       The start position tuple.\r
109     #   @param  End         The end position tuple.\r
110     #\r
111     def __init__(self, Str, Begin, End):\r
112         self.Content = Str\r
113         self.StartPos = Begin\r
114         self.EndPos = End\r
115 \r
116 ## The description of struct/union definition and start & end position\r
117 #\r
118 #\r
119 class StructUnionDefinition :\r
120     ## The constructor\r
121     #\r
122     #   @param  self        The object pointer\r
123     #   @param  Str         The message to record\r
124     #   @param  Begin       The start position tuple.\r
125     #   @param  End         The end position tuple.\r
126     #\r
127     def __init__(self, Str, Begin, End):\r
128         self.Content = Str\r
129         self.StartPos = Begin\r
130         self.EndPos = End\r
131 \r
132 ## The description of 'Typedef' definition and start & end position\r
133 #\r
134 #\r
135 class TypedefDefinition :\r
136     ## The constructor\r
137     #\r
138     #   @param  self        The object pointer\r
139     #   @param  Str         The message to record\r
140     #   @param  Begin       The start position tuple.\r
141     #   @param  End         The end position tuple.\r
142     #\r
143     def __init__(self, FromStr, ToStr, Begin, End):\r
144         self.FromType = FromStr\r
145         self.ToType = ToStr\r
146         self.StartPos = Begin\r
147         self.EndPos = End\r
148         \r
149