SVF::GrammarBase Class Reference

#include <CFGrammar.h>

Inheritance diagram for SVF::GrammarBase:

Classes
struct	Symbol
class	SymbolHash
struct	SymbolVectorHash

Public Types
typedef u32_t	Kind
typedef u32_t	Attribute
typedef u32_t	VariableAttribute
typedef struct SVF::GrammarBase::Symbol	Symbol
template<typename Key , typename Value , typename Hash = SymbolHash, typename KeyEqual = std::equal_to<Key>, typename Allocator = std::allocator<std::pair<const Key, Value>>>
using	SymbolMap = std::unordered_map< Key, Value, Hash, KeyEqual, Allocator >
template<typename Key , typename Hash = SymbolVectorHash, typename KeyEqual = std::equal_to<Key>, typename Allocator = std::allocator<Key>>
using	SymbolSet = std::unordered_set< Key, Hash, KeyEqual, Allocator >
typedef std::vector< Symbol >	Production
typedef SymbolSet< Production >	Productions

Public Member Functions
Map< std::string, Kind > &	getNonterminals ()
void	setNonterminals (Map< std::string, Kind > &nonterminals)
Map< std::string, Kind > &	getTerminals ()
void	setTerminals (Map< std::string, Kind > &terminals)
Map< std::string, Kind > &	getEBNFSigns ()
void	setEBNFSigns (Map< std::string, Kind > &EBNFSigns)
SymbolMap< Symbol, Productions > &	getRawProductions ()
const Map< Kind, Set< Attribute > > &	getKindToAttrsMap () const
Kind	getTotalKind ()
Kind	getStartKind ()
void	setStartKind (Kind startKind)
void	setTotalKind (Kind totalKind)
std::string	extractKindStrFromSymbolStr (const std::string &symbolStr) const
std::string	extractAttributeStrFromSymbolStr (const std::string &symbolStr) const
void	setRawProductions (SymbolMap< Symbol, Productions > &rawProductions)
void	setKindToAttrsMap (const Map< Kind, Set< Attribute >> &kindToAttrsMap)
void	setAttributeKinds (const Set< Kind > &attributeKind)
Kind	strToKind (std::string str) const
Symbol	strToSymbol (const std::string str) const
std::string	kindToStr (Kind kind) const
std::string	symToStrDump (Symbol sym) const
Symbol	getSymbol (const Production &prod, u32_t pos)
const Set< Kind > &	getAttrSyms () const
Kind	insertNonterminalKind (std::string const kindStr)
	Insert kind to nonterminal and return kind. More...
Kind	insertTerminalKind (std::string strLit)
Symbol	insertSymbol (std::string strLit)
Symbol	insertNonTerminalSymbol (std::string strLit)
Symbol	insertTerminalSymbol (std::string strLit)
Symbol	insertEBNFSigns (std::string strLit)
void	insertAttribute (Kind kind, Attribute a)

Static Public Member Functions
static Kind	getAttributedKind (Attribute attribute, Kind kind)
static Kind	getVariabledKind (VariableAttribute variableAttribute, Kind kind)

Protected Attributes
Kind	startKind

Static Protected Attributes
static constexpr unsigned char	EdgeKindMaskBits = 8
	We use the lower 8 bits to denote edge kind. More...
static constexpr unsigned char	AttributedKindMaskBits = 24
	We use the lower 24 bits to denote attributed kind. More...
static constexpr u64_t	EdgeKindMask = (~0ULL) >> (64 - EdgeKindMaskBits)

Private Attributes
Map< std::string, Kind >	nonterminals
Map< std::string, Kind >	terminals
Map< std::string, Kind >	EBNFSigns
Set< Kind >	attributeKinds
	Map contains Signs' String and associated Symbols. More...
Map< Kind, Set< Attribute > >	kindToAttrsMap
SymbolMap< Symbol, Productions >	rawProductions
u32_t	totalKind

Detailed Description

Definition at line 36 of file CFGrammar.h.

Member Typedef Documentation

Attribute

typedef u32_t SVF::GrammarBase::Attribute

Definition at line 40 of file CFGrammar.h.

Kind

typedef u32_t SVF::GrammarBase::Kind

Definition at line 39 of file CFGrammar.h.

Production

typedef std::vector<Symbol> SVF::GrammarBase::Production

Definition at line 156 of file CFGrammar.h.

Productions

typedef SymbolSet<Production> SVF::GrammarBase::Productions

Definition at line 157 of file CFGrammar.h.

Symbol

typedef struct SVF::GrammarBase::Symbol SVF::GrammarBase::Symbol

SymbolMap

template<typename Key , typename Value , typename Hash = SymbolHash, typename KeyEqual = std::equal_to<Key>, typename Allocator = std::allocator<std::pair<const Key, Value>>>

using SVF::GrammarBase::SymbolMap = std::unordered_map<Key, Value, Hash, KeyEqual, Allocator>

Definition at line 150 of file CFGrammar.h.

SymbolSet

template<typename Key , typename Hash = SymbolVectorHash, typename KeyEqual = std::equal_to<Key>, typename Allocator = std::allocator<Key>>

using SVF::GrammarBase::SymbolSet = std::unordered_set<Key, Hash, KeyEqual, Allocator>

Definition at line 154 of file CFGrammar.h.

VariableAttribute

typedef u32_t SVF::GrammarBase::VariableAttribute

Definition at line 41 of file CFGrammar.h.

Member Function Documentation

extractAttributeStrFromSymbolStr()

std::string GrammarBase::extractAttributeStrFromSymbolStr

(

const std::string &

symbolStr

)

const

Definition at line 219 of file CFGrammar.cpp.

{
    std::string attributeStr;
    // symbolStr end with '_', the whole symbolStr treat as kind, not with attribute.
    auto underscorePosition = symbolStr.find_last_of("_", symbolStr.size()-1);
    if (underscorePosition == std::string::npos)
    {
        return "";
    }
    return symbolStr.substr(underscorePosition+1);
}

extractKindStrFromSymbolStr()

std::string GrammarBase::extractKindStrFromSymbolStr

(

const std::string &

symbolStr

)

const

Definition at line 207 of file CFGrammar.cpp.

{
    std::string kindStr;
    // symbolStr end with '_', the whole symbolStr treat as kind, not with attribute.
    auto underscorePosition = symbolStr.find_last_of("_", symbolStr.size()-1);
    if (underscorePosition == std::string::npos)
    {
        return symbolStr;
    }
    return symbolStr.substr(0, underscorePosition);
}

getAttributedKind()

static Kind SVF::GrammarBase::getAttributedKind ( Attribute  attribute, Kind  kind  )

inlinestatic

Definition at line 265 of file CFGrammar.h.

    {
        return ((attribute << EdgeKindMaskBits)| kind );
    }

getAttrSyms()

const Set<Kind>& SVF::GrammarBase::getAttrSyms ( ) const

inline

Definition at line 243 of file CFGrammar.h.

    {
        return this->attributeKinds;
    }

getEBNFSigns()

Map<std::string, Kind>& SVF::GrammarBase::getEBNFSigns ( )

inline

Definition at line 180 of file CFGrammar.h.

    {
        return this->EBNFSigns;
    }

getKindToAttrsMap()

const Map<Kind, Set<Attribute> >& SVF::GrammarBase::getKindToAttrsMap ( ) const

inline

Definition at line 195 of file CFGrammar.h.

    {
        return this->kindToAttrsMap;
    }

getNonterminals()

Map<std::string, Kind>& SVF::GrammarBase::getNonterminals ( )

inline

Definition at line 160 of file CFGrammar.h.

    {
        return this->nonterminals;
    }

getRawProductions()

SymbolMap<Symbol, Productions>& SVF::GrammarBase::getRawProductions ( )

inline

Definition at line 190 of file CFGrammar.h.

    {
        return this->rawProductions;
    }

getStartKind()

Kind SVF::GrammarBase::getStartKind ( )

inline

Definition at line 205 of file CFGrammar.h.

    {
        return this->startKind;
    }

getSymbol()

Symbol SVF::GrammarBase::getSymbol ( const Production &  prod, u32_t  pos  )

inline

Definition at line 238 of file CFGrammar.h.

    {
        return prod.at(pos);
    }

getTerminals()

Map<std::string, Kind>& SVF::GrammarBase::getTerminals ( )

inline

Definition at line 170 of file CFGrammar.h.

    {
        return this->terminals;
    }

getTotalKind()

Kind SVF::GrammarBase::getTotalKind ( )

inline

Definition at line 200 of file CFGrammar.h.

    {
        return this->totalKind;
    }

getVariabledKind()

static Kind SVF::GrammarBase::getVariabledKind ( VariableAttribute  variableAttribute, Kind  kind  )

inlinestatic

Definition at line 270 of file CFGrammar.h.

    {
        return ((variableAttribute << AttributedKindMaskBits) | kind);
    }

insertAttribute()

void GrammarBase::insertAttribute	(	Kind	kind,
		Attribute	a
	)

Definition at line 327 of file CFGrammar.cpp.

{
    attributeKinds.insert(kind);
    if (kindToAttrsMap.find(kind)!= kindToAttrsMap.end())
    {
        kindToAttrsMap[kind].insert(attribute);
    }
    else
    {
        Set<CFGrammar::Attribute> attrs {attribute};
        kindToAttrsMap.insert(make_pair(kind, attrs));
    }
}

insertEBNFSigns()

GrammarBase::Symbol GrammarBase::insertEBNFSigns

(

std::string

strLit

)

Definition at line 311 of file CFGrammar.cpp.

{
    Symbol sign;
    if (EBNFSigns.find(symbolStr) == EBNFSigns.end())
    {
        sign = totalKind++;
        EBNFSigns.insert({symbolStr, sign});
    }
    else
    {
        sign = strToKind(symbolStr);
    }
    return sign;
 
}

insertNonterminalKind()

GrammarBase::Kind GrammarBase::insertNonterminalKind ( std::string const  kindStr )

inline

Insert kind to nonterminal and return kind.

Definition at line 192 of file CFGrammar.cpp.

{
    Kind kind;
    if (nonterminals.find(kindStr) == nonterminals.end())
    {
        kind = totalKind++;
        nonterminals.insert({kindStr, kind});
    }
    else
    {
        kind = strToKind(kindStr);
    }
    return kind;
}

insertNonTerminalSymbol()

GrammarBase::Symbol GrammarBase::insertNonTerminalSymbol

(

std::string

strLit

)

Definition at line 249 of file CFGrammar.cpp.

{
    Symbol symbol;
    std::string kindStr = extractKindStrFromSymbolStr(symbolStr);
    std::string attributeStr = extractAttributeStrFromSymbolStr(symbolStr);
    symbol.kind = insertNonterminalKind(kindStr);
 
    if ( attributeStr == "") return symbol;
 
    if ( (attributeStr.size() == 1) && (std::isalpha(attributeStr[attributeStr.size()-1])) )
    {
        attributeKinds.insert(symbol.kind);
        symbol.variableAttribute = (u32_t)attributeStr[attributeStr.size()-1];
    }
    else
    {
        for( char &c : attributeStr)
        {
            if ( std::isdigit(c) == false )
            {
                SVFUtil::errs() << SVFUtil::errMsg("\t Symbol Attribute Parse Failure :") << symbolStr
                                << " Attribute:" << attributeStr << " (only number or single alphabet.)";
                assert(false && "grammar loading failed!");
            }
        }
        attributeKinds.insert(symbol.kind);
        symbol.attribute = std::stoi(attributeStr);
    }
    return symbol;
}

insertSymbol()

GrammarBase::Symbol GrammarBase::insertSymbol

(

std::string

strLit

)

Definition at line 231 of file CFGrammar.cpp.

{
    Symbol symbol;
    if ((symbolStr.size() == 1) && (!isalpha(symbolStr[0])))
    {
        symbol = insertEBNFSigns(symbolStr);
    }
    else if (isupper(symbolStr[0]))
    {
        symbol = insertNonTerminalSymbol(symbolStr);
    }
    else
    {
        symbol = insertTerminalSymbol(symbolStr);
    }
    return symbol;
}

insertTerminalKind()

GrammarBase::Kind GrammarBase::insertTerminalKind

(

std::string

strLit

)

From SymbolStr extract kind to inserted in nonterminal symbolStr = <kindStr> [_] [ attributeStr | variableattributeStr ]

Definition at line 177 of file CFGrammar.cpp.

{
    Kind kind;
    if (terminals.find(kindStr) == terminals.end())
    {
        kind = totalKind++;
        terminals.insert({kindStr, kind});
    }
    else
    {
        kind = strToKind(kindStr);
    }
    return kind;
}

insertTerminalSymbol()

GrammarBase::Symbol GrammarBase::insertTerminalSymbol

(

std::string

strLit

)

Definition at line 280 of file CFGrammar.cpp.

{
    Symbol symbol;
    std::string kindStr = extractKindStrFromSymbolStr(symbolStr);
    std::string attributeStr = extractAttributeStrFromSymbolStr(symbolStr);
    symbol.kind = insertTerminalKind(kindStr);
 
    if ( attributeStr == "") return symbol;
 
    if ( (attributeStr.size() == 1) && (std::isalpha(attributeStr[attributeStr.size()-1])) )
    {
        attributeKinds.insert(symbol.kind);
        symbol.variableAttribute = (u32_t)attributeStr[attributeStr.size()-1];
    }
    else
    {
        for( char &c : attributeStr)
        {
            if ( std::isdigit(c) == false )
            {
                SVFUtil::errs() << SVFUtil::errMsg("\t Symbol Attribute Parse Failure :") << symbolStr
                                << " Attribute:" << attributeStr << " (only number or single alphabet.)";
                assert(false && "grammar loading failed!");
            }
        }
        attributeKinds.insert(symbol.kind);
        symbol.attribute = std::stoi(attributeStr);
    }
    return symbol;
}

kindToStr()

std::string GrammarBase::kindToStr

(

Kind

kind

)

const

Definition at line 103 of file CFGrammar.cpp.

{
 
    std::string key = "";
    for (auto &i : terminals)
    {
        if (i.second == kind)
        {
            key = i.first;
            return key;
        }
    }
 
    std::string nkey = "";
    for (auto &ni : nonterminals)
    {
        if (ni.second == kind)
        {
            nkey = ni.first;
            return nkey;
        }
    }
 
    std::string signs = "";
    for (auto &i : EBNFSigns)
    {
        if (i.second == kind)
        {
            signs = i.first;
            return signs;
        }
    }
 
    return "";
}

setAttributeKinds()

void GrammarBase::setAttributeKinds

(

const Set< Kind > &

attributeKind

)

Definition at line 50 of file CFGrammar.cpp.

{
    this->attributeKinds = attributeKinds;
}

setEBNFSigns()

void SVF::GrammarBase::setEBNFSigns ( Map< std::string, Kind > &  EBNFSigns )

inline

Definition at line 185 of file CFGrammar.h.

    {
        this->EBNFSigns = EBNFSigns;
    }

setKindToAttrsMap()

void GrammarBase::setKindToAttrsMap

(

const Map< Kind, Set< Attribute >> &

kindToAttrsMap

)

Definition at line 45 of file CFGrammar.cpp.

{
    this->kindToAttrsMap = kindToAttrsMap;
}

setNonterminals()

void SVF::GrammarBase::setNonterminals ( Map< std::string, Kind > &  nonterminals )

inline

Definition at line 165 of file CFGrammar.h.

    {
        this->nonterminals = nonterminals;
    }

setRawProductions()

void GrammarBase::setRawProductions

(

SymbolMap< Symbol, Productions > &

rawProductions

)

Definition at line 40 of file CFGrammar.cpp.

{
    this->rawProductions = rawProductions;
}

setStartKind()

void SVF::GrammarBase::setStartKind ( Kind  startKind )

inline

Definition at line 210 of file CFGrammar.h.

    {
        this->startKind = startKind;
    }

setTerminals()

void SVF::GrammarBase::setTerminals ( Map< std::string, Kind > &  terminals )

inline

Definition at line 175 of file CFGrammar.h.

    {
        this->terminals = terminals;
    }

setTotalKind()

void SVF::GrammarBase::setTotalKind ( Kind  totalKind )

inline

Definition at line 215 of file CFGrammar.h.

    {
        this->totalKind = totalKind;
    }

strToKind()

GrammarBase::Kind GrammarBase::strToKind

(

std::string

str

)

const

Definition at line 55 of file CFGrammar.cpp.

{
 
    auto tit = terminals.find(str);
    if(tit!=terminals.end())
        return tit->second;
 
    auto nit = nonterminals.find(str);
    if(nit!=nonterminals.end())
        return nit->second;
 
    auto sit = EBNFSigns.find(str);
    if(sit!=EBNFSigns.end())
        return sit->second;
 
    assert(false && "kind not found!");
    abort();
}

strToSymbol()

GrammarBase::Symbol GrammarBase::strToSymbol

(

const std::string

str

)

const

Definition at line 74 of file CFGrammar.cpp.

{
    Symbol symbol;
    std::string attributeStr = extractAttributeStrFromSymbolStr(str);
    std::string kindStr = extractKindStrFromSymbolStr(str);
    symbol.kind = strToKind(kindStr);
 
    if ( attributeStr == "") return symbol;
 
    if ( (attributeStr.size() == 1) && (std::isalpha(attributeStr[attributeStr.size()-1])) )
    {
        symbol.variableAttribute = (u32_t)attributeStr[attributeStr.size()-1];
    }
    else
    {
        for( char &c : attributeStr)
        {
            if ( std::isdigit(c) == false )
            {
                SVFUtil::errs() << SVFUtil::errMsg("\t Symbol Attribute Parse Failure :") << str
                                << " Attribute:" << attributeStr << " (only number or single alphabet.)";
                assert(false && "grammar loading failed!");
            }
        }
        symbol.attribute = std::stoi(attributeStr);
    }
    return symbol;
}

symToStrDump()

std::string GrammarBase::symToStrDump

(

Symbol

sym

)

const

Definition at line 139 of file CFGrammar.cpp.

{
    Kind kind = sym.kind;
    Attribute attribute = sym.attribute;
 
    std::string key = "";
    for (auto &i : terminals)
    {
        if (i.second == kind)
        {
            key = i.first;
            if(attribute != 0)
            {
                key.append("_");
                key.append(std::to_string(attribute));
            }
            return key;
        }
    }
 
    std::string nkey = "";
    for (auto &ni : nonterminals)
    {
        if (ni.second == kind)
        {
            nkey = ni.first;
            if(attribute != 0)
            {
                nkey.append("_");
                nkey.append(std::to_string(attribute));
            }
            return nkey;
        }
    }
 
    return "";
}

Member Data Documentation

AttributedKindMaskBits

constexpr unsigned char SVF::GrammarBase::AttributedKindMaskBits = 24

staticconstexprprotected

We use the lower 24 bits to denote attributed kind.

Definition at line 277 of file CFGrammar.h.

attributeKinds

Set<Kind> SVF::GrammarBase::attributeKinds

private

Map contains Signs' String and associated Symbols.

Definition at line 284 of file CFGrammar.h.

EBNFSigns

Map<std::string, Kind> SVF::GrammarBase::EBNFSigns

private

Definition at line 283 of file CFGrammar.h.

EdgeKindMask

constexpr u64_t SVF::GrammarBase::EdgeKindMask = (~0ULL) >> (64 - EdgeKindMaskBits)

staticconstexprprotected

Definition at line 278 of file CFGrammar.h.

EdgeKindMaskBits

constexpr unsigned char SVF::GrammarBase::EdgeKindMaskBits = 8

staticconstexprprotected

We use the lower 8 bits to denote edge kind.

Definition at line 276 of file CFGrammar.h.

kindToAttrsMap

Map<Kind, Set<Attribute> > SVF::GrammarBase::kindToAttrsMap

private

Definition at line 285 of file CFGrammar.h.

nonterminals

Map<std::string, Kind> SVF::GrammarBase::nonterminals

private

Definition at line 281 of file CFGrammar.h.

rawProductions

SymbolMap<Symbol, Productions> SVF::GrammarBase::rawProductions

private

Definition at line 286 of file CFGrammar.h.

startKind

Kind SVF::GrammarBase::startKind

protected

Definition at line 279 of file CFGrammar.h.

terminals

Map<std::string, Kind> SVF::GrammarBase::terminals

private

Definition at line 282 of file CFGrammar.h.

totalKind

u32_t SVF::GrammarBase::totalKind

private

Definition at line 287 of file CFGrammar.h.

---

The documentation for this class was generated from the following files:

• /home/runner/work/SVF/SVF/svf/include/CFL/CFGrammar.h
• /home/runner/work/SVF/SVF/svf/lib/CFL/CFGrammar.cpp