2 // Copyright (C) 2002-2005 3Dlabs Inc. Ltd.
3 // Copyright (C) 2012-2013 LunarG, Inc.
4 // Copyright (C) 2017 ARM Limited.
5 // Copyright (C) 2015-2018 Google, Inc.
7 // All rights reserved.
9 // Redistribution and use in source and binary forms, with or without
10 // modification, are permitted provided that the following conditions
13 // Redistributions of source code must retain the above copyright
14 // notice, this list of conditions and the following disclaimer.
16 // Redistributions in binary form must reproduce the above
17 // copyright notice, this list of conditions and the following
18 // disclaimer in the documentation and/or other materials provided
19 // with the distribution.
21 // Neither the name of 3Dlabs Inc. Ltd. nor the names of its
22 // contributors may be used to endorse or promote products derived
23 // from this software without specific prior written permission.
25 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
28 // FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
29 // COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
30 // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
31 // BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
32 // LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
33 // CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34 // LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
35 // ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 // POSSIBILITY OF SUCH DAMAGE.
40 // Symbol table for parsing. Most functionality and main ideas
41 // are documented in the header file.
44 #include "SymbolTable.h"
49 // TType helper function needs a place to live.
53 // Recursively generate mangled names.
55 void TType::buildMangledName(TString& mangledName) const
63 case EbtFloat: mangledName += 'f'; break;
64 case EbtDouble: mangledName += 'd'; break;
65 case EbtFloat16: mangledName += "f16"; break;
66 case EbtInt: mangledName += 'i'; break;
67 case EbtUint: mangledName += 'u'; break;
68 case EbtInt8: mangledName += "i8"; break;
69 case EbtUint8: mangledName += "u8"; break;
70 case EbtInt16: mangledName += "i16"; break;
71 case EbtUint16: mangledName += "u16"; break;
72 case EbtInt64: mangledName += "i64"; break;
73 case EbtUint64: mangledName += "u64"; break;
74 case EbtBool: mangledName += 'b'; break;
75 case EbtAtomicUint: mangledName += "au"; break;
77 case EbtAccStructNV: mangledName += "asnv"; break;
80 switch (sampler.type) {
82 case EbtFloat16: mangledName += "f16"; break;
84 case EbtInt: mangledName += "i"; break;
85 case EbtUint: mangledName += "u"; break;
86 default: break; // some compilers want this
89 mangledName += "I"; // a normal image
90 else if (sampler.sampler)
91 mangledName += "p"; // a "pure" sampler
92 else if (!sampler.combined)
93 mangledName += "t"; // a "pure" texture
95 mangledName += "s"; // traditional combined sampler
100 if (sampler.external)
104 switch (sampler.dim) {
105 case Esd1D: mangledName += "1"; break;
106 case Esd2D: mangledName += "2"; break;
107 case Esd3D: mangledName += "3"; break;
108 case EsdCube: mangledName += "C"; break;
109 case EsdRect: mangledName += "R2"; break;
110 case EsdBuffer: mangledName += "B"; break;
111 case EsdSubpass: mangledName += "P"; break;
112 default: break; // some compilers want this
115 if (sampler.hasReturnStruct()) {
116 // Name mangle for sampler return struct uses struct table index.
117 mangledName += "-tx-struct";
119 char text[16]; // plenty enough space for the small integers.
120 snprintf(text, sizeof(text), "%d-", sampler.structReturnIndex);
123 switch (sampler.getVectorSize()) {
124 case 1: mangledName += "1"; break;
125 case 2: mangledName += "2"; break;
126 case 3: mangledName += "3"; break;
127 case 4: break; // default to prior name mangle behavior
136 if (basicType == EbtStruct)
137 mangledName += "struct-";
139 mangledName += "block-";
141 mangledName += *typeName;
142 for (unsigned int i = 0; i < structure->size(); ++i) {
144 (*structure)[i].type->buildMangledName(mangledName);
150 if (getVectorSize() > 0)
151 mangledName += static_cast<char>('0' + getVectorSize());
153 mangledName += static_cast<char>('0' + getMatrixCols());
154 mangledName += static_cast<char>('0' + getMatrixRows());
158 const int maxSize = 11;
160 for (int i = 0; i < arraySizes->getNumDims(); ++i) {
161 if (arraySizes->getDimNode(i)) {
162 if (arraySizes->getDimNode(i)->getAsSymbolNode())
163 snprintf(buf, maxSize, "s%d", arraySizes->getDimNode(i)->getAsSymbolNode()->getId());
165 snprintf(buf, maxSize, "s%p", arraySizes->getDimNode(i));
167 snprintf(buf, maxSize, "%d", arraySizes->getDimSize(i));
179 void TVariable::dump(TInfoSink& infoSink) const
181 infoSink.debug << getName().c_str() << ": " << type.getStorageQualifierString() << " " << type.getBasicTypeString();
182 if (type.isArray()) {
183 infoSink.debug << "[0]";
185 infoSink.debug << "\n";
188 void TFunction::dump(TInfoSink& infoSink) const
190 infoSink.debug << getName().c_str() << ": " << returnType.getBasicTypeString() << " " << getMangledName().c_str() << "\n";
193 void TAnonMember::dump(TInfoSink& TInfoSink) const
195 TInfoSink.debug << "anonymous member " << getMemberNumber() << " of " << getAnonContainer().getName().c_str() << "\n";
198 void TSymbolTableLevel::dump(TInfoSink &infoSink) const
200 tLevel::const_iterator it;
201 for (it = level.begin(); it != level.end(); ++it)
202 (*it).second->dump(infoSink);
205 void TSymbolTable::dump(TInfoSink &infoSink) const
207 for (int level = currentLevel(); level >= 0; --level) {
208 infoSink.debug << "LEVEL " << level << "\n";
209 table[level]->dump(infoSink);
214 // Functions have buried pointers to delete.
216 TFunction::~TFunction()
218 for (TParamList::iterator i = parameters.begin(); i != parameters.end(); ++i)
223 // Symbol table levels are a map of pointers to symbols that have to be deleted.
225 TSymbolTableLevel::~TSymbolTableLevel()
227 for (tLevel::iterator it = level.begin(); it != level.end(); ++it)
230 delete [] defaultPrecision;
234 // Change all function entries in the table with the non-mangled name
235 // to be related to the provided built-in operation.
237 void TSymbolTableLevel::relateToOperator(const char* name, TOperator op)
239 tLevel::const_iterator candidate = level.lower_bound(name);
240 while (candidate != level.end()) {
241 const TString& candidateName = (*candidate).first;
242 TString::size_type parenAt = candidateName.find_first_of('(');
243 if (parenAt != candidateName.npos && candidateName.compare(0, parenAt, name) == 0) {
244 TFunction* function = (*candidate).second->getAsFunction();
245 function->relateToOperator(op);
252 // Make all function overloads of the given name require an extension(s).
253 // Should only be used for a version/profile that actually needs the extension(s).
254 void TSymbolTableLevel::setFunctionExtensions(const char* name, int num, const char* const extensions[])
256 tLevel::const_iterator candidate = level.lower_bound(name);
257 while (candidate != level.end()) {
258 const TString& candidateName = (*candidate).first;
259 TString::size_type parenAt = candidateName.find_first_of('(');
260 if (parenAt != candidateName.npos && candidateName.compare(0, parenAt, name) == 0) {
261 TSymbol* symbol = candidate->second;
262 symbol->setExtensions(num, extensions);
270 // Make all symbols in this table level read only.
272 void TSymbolTableLevel::readOnly()
274 for (tLevel::iterator it = level.begin(); it != level.end(); ++it)
275 (*it).second->makeReadOnly();
279 // Copy a symbol, but the copy is writable; call readOnly() afterward if that's not desired.
281 TSymbol::TSymbol(const TSymbol& copyOf)
283 name = NewPoolTString(copyOf.name->c_str());
284 uniqueId = copyOf.uniqueId;
288 TVariable::TVariable(const TVariable& copyOf) : TSymbol(copyOf)
290 type.deepCopy(copyOf.type);
291 userType = copyOf.userType;
293 // we don't support specialization-constant subtrees in cloned tables, only extensions
294 constSubtree = nullptr;
295 extensions = nullptr;
296 memberExtensions = nullptr;
297 if (copyOf.getNumExtensions() > 0)
298 setExtensions(copyOf.getNumExtensions(), copyOf.getExtensions());
299 if (copyOf.hasMemberExtensions()) {
300 for (int m = 0; m < (int)copyOf.type.getStruct()->size(); ++m) {
301 if (copyOf.getNumMemberExtensions(m) > 0)
302 setMemberExtensions(m, copyOf.getNumMemberExtensions(m), copyOf.getMemberExtensions(m));
306 if (! copyOf.constArray.empty()) {
307 assert(! copyOf.type.isStruct());
308 TConstUnionArray newArray(copyOf.constArray, 0, copyOf.constArray.size());
309 constArray = newArray;
313 TVariable* TVariable::clone() const
315 TVariable *variable = new TVariable(*this);
320 TFunction::TFunction(const TFunction& copyOf) : TSymbol(copyOf)
322 for (unsigned int i = 0; i < copyOf.parameters.size(); ++i) {
324 parameters.push_back(param);
325 parameters.back().copyParam(copyOf.parameters[i]);
328 extensions = nullptr;
329 if (copyOf.getNumExtensions() > 0)
330 setExtensions(copyOf.getNumExtensions(), copyOf.getExtensions());
331 returnType.deepCopy(copyOf.returnType);
332 mangledName = copyOf.mangledName;
334 defined = copyOf.defined;
335 prototyped = copyOf.prototyped;
336 implicitThis = copyOf.implicitThis;
337 illegalImplicitThis = copyOf.illegalImplicitThis;
338 defaultParamCount = copyOf.defaultParamCount;
341 TFunction* TFunction::clone() const
343 TFunction *function = new TFunction(*this);
348 TAnonMember* TAnonMember::clone() const
350 // Anonymous members of a given block should be cloned at a higher level,
351 // where they can all be assured to still end up pointing to a single
352 // copy of the original container.
358 TSymbolTableLevel* TSymbolTableLevel::clone() const
360 TSymbolTableLevel *symTableLevel = new TSymbolTableLevel();
361 symTableLevel->anonId = anonId;
362 symTableLevel->thisLevel = thisLevel;
363 std::vector<bool> containerCopied(anonId, false);
364 tLevel::const_iterator iter;
365 for (iter = level.begin(); iter != level.end(); ++iter) {
366 const TAnonMember* anon = iter->second->getAsAnonMember();
368 // Insert all the anonymous members of this same container at once,
369 // avoid inserting the remaining members in the future, once this has been done,
370 // allowing them to all be part of the same new container.
371 if (! containerCopied[anon->getAnonId()]) {
372 TVariable* container = anon->getAnonContainer().clone();
373 container->changeName(NewPoolTString(""));
374 // insert the container and all its members
375 symTableLevel->insert(*container, false);
376 containerCopied[anon->getAnonId()] = true;
379 symTableLevel->insert(*iter->second->clone(), false);
382 return symTableLevel;
385 void TSymbolTable::copyTable(const TSymbolTable& copyOf)
387 assert(adoptedLevels == copyOf.adoptedLevels);
389 uniqueId = copyOf.uniqueId;
390 noBuiltInRedeclarations = copyOf.noBuiltInRedeclarations;
391 separateNameSpaces = copyOf.separateNameSpaces;
392 for (unsigned int i = copyOf.adoptedLevels; i < copyOf.table.size(); ++i)
393 table.push_back(copyOf.table[i]->clone());
396 } // end namespace glslang