summaryrefslogtreecommitdiffstats
path: root/BaseTools/Scripts/PackageDocumentTools/plugins/EdkPlugins/edk2/model/dsc.py
blob: 0628fa7408261f2463f7c84b1cd4bca750314373 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
## @file
#
# Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>
#
# This program and the accompanying materials are licensed and made available
# under the terms and conditions of the BSD License which accompanies this
# distribution. The full text of the license may be found at
# http://opensource.org/licenses/bsd-license.php
#
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#

import plugins.EdkPlugins.basemodel.ini as ini
import re, os
from plugins.EdkPlugins.basemodel.message import *

class DSCFile(ini.BaseINIFile):
    def GetSectionInstance(self, parent, name, isCombined=False):
        return DSCSection(parent, name, isCombined)

    def GetComponents(self):
        return self.GetSectionObjectsByName('Components')

class DSCSection(ini.BaseINISection):
    def GetSectionINIObject(self, parent):
        type = self.GetType()

        if type.lower() == 'components':
            return DSCComponentObject(self)
        if type.lower() == 'libraryclasses':
            return DSCLibraryClassObject(self)
        if type.lower() == 'defines':
            return ini.BaseINISectionObject(self)
        if type.lower() == 'pcdsfeatureflag' or \
           type.lower() == 'pcdsfixedatbuild' or \
           type.lower() == 'pcdspatchableinmodule' or\
           type.lower() == 'pcdsdynamicdefault' or \
           type.lower() == 'pcdsdynamicex' or \
           type.lower() == 'pcdsdynamichii' or \
           type.lower() == 'pcdsdynamicvpd':
            return DSCPcdObject(self)

        return DSCSectionObject(self)

    def GetType(self):
        arr = self._name.split('.')
        return arr[0].strip()

    def GetArch(self):
        arr = self._name.split('.')
        if len(arr) == 1:
            return 'common'
        return arr[1]

    def GetModuleType(self):
        arr = self._name.split('.')
        if len(arr) < 3:
            return 'common'
        return arr[2]

class DSCSectionObject(ini.BaseINISectionObject):
    def GetArch(self):
        return self.GetParent().GetArch()

class DSCPcdObject(DSCSectionObject):

    def __init__(self, parent):
        ini.BaseINISectionObject.__init__(self, parent)
        self._name = None

    def Parse(self):
        line = self.GetLineByOffset(self._start).strip().split('#')[0]
        self._name   = line.split('|')[0]
        self._value  = line.split('|')[1]
        return True

    def GetPcdName(self):
        return self._name

    def GetPcdType(self):
        return self.GetParent().GetType()

    def GetPcdValue(self):
        return self._value

class DSCLibraryClassObject(DSCSectionObject):
    def __init__(self, parent):
        ini.BaseINISectionObject.__init__(self, parent)

    def GetClass(self):
        line = self.GetLineByOffset(self._start)
        return line.split('#')[0].split('|')[0].strip()

    def GetInstance(self):
        line = self.GetLineByOffset(self._start)
        return line.split('#')[0].split('|')[1].strip()

    def GetArch(self):
        return self.GetParent().GetArch()

    def GetModuleType(self):
        return self.GetParent().GetModuleType()

class DSCComponentObject(DSCSectionObject):

    def __init__(self, parent):
        ini.BaseINISectionObject.__init__(self, parent)
        self._OveridePcds      = {}
        self._OverideLibraries = {}
        self._Filename         = ''

    def __del__(self):
        self._OverideLibraries.clear()
        self._OverideLibraries.clear()
        ini.BaseINISectionObject.__del__(self)

    def AddOverideLib(self, libclass, libinstPath):
        if libclass not in self._OverideLibraries.keys():
            self._OverideLibraries[libclass] = libinstPath

    def AddOveridePcd(self, name, type, value=None):
        if type not in self._OveridePcds.keys():
            self._OveridePcds[type] = []
        self._OveridePcds[type].append((name, value))

    def GetOverideLibs(self):
        return self._OverideLibraries

    def GetArch(self):
        return self.GetParent().GetArch()

    def GetOveridePcds(self):
        return self._OveridePcds

    def GetFilename(self):
        return self.GetLineByOffset(self._start).split('#')[0].split('{')[0].strip()

    def SetFilename(self, fName):
        self._Filename = fName

    def Parse(self):
        if (self._start < self._end):
            #
            # The first line is inf path and could be ignored
            # The end line is '}' and could be ignored
            #
            curr = self._start + 1
            end  = self._end - 1
            OverideName = ''
            while (curr <= end):
                line = self.GetLineByOffset(curr).strip()
                if len(line) > 0 and line[0] != '#':
                    line = line.split('#')[0].strip()
                    if line[0] == '<':
                        OverideName = line[1:len(line)-1]
                    elif OverideName.lower() == 'libraryclasses':
                        arr = line.split('|')
                        self._OverideLibraries[arr[0].strip()] = arr[1].strip()
                    elif OverideName.lower() == 'pcds':
                        ErrorMsg('EDES does not support PCD overide',
                                 self.GetFileName(),
                                 self.GetParent().GetLinenumberByOffset(curr))
                curr = curr + 1
        return True

    def GenerateLines(self):
        lines = []
        hasLib = False
        hasPcd = False
        if len(self._OverideLibraries) != 0:
            hasLib = True
        if len(self._OveridePcds) != 0:
            hasPcd = True

        if hasLib or hasPcd:
            lines.append(('  %s {\n' % self._Filename))
        else:
            lines.append(('  %s \n' % self._Filename))
            return lines

        if hasLib:
            lines.append('    <LibraryClasses>\n')
            for libKey in self._OverideLibraries.keys():
                lines.append('      %s|%s\n' % (libKey, self._OverideLibraries[libKey]))

        if hasPcd:
            for key in self._OveridePcds.keys():
                lines.append('    <%s>\n' % key)

                for name, value in self._OveridePcds[key]:
                    if value is not None:
                        lines.append('      %s|%s\n' % (name, value))
                    else:
                        lines.append('      %s\n' % name)

        if hasLib or hasPcd:
            lines.append('  }\n')

        return lines