cpg-language-go/de.fraunhofer.aisec.cpg.frontends.golang

Package-level declarations

Types

class BuildConstraintBinaryExpression(val operatorCode: String, val lhs: BuildConstraintExpression, val rhs: BuildConstraintExpression) : BuildConstraintExpression

A binary build constraint expression. Currently, only && and || as operatorCode are supported.

BuildConstraintExpression

fun interface BuildConstraintExpression

Go allows to specify so-called build constraints on files, to specify conditions on which they should be built (or not).

BuildConstraintParenthesis

class BuildConstraintParenthesis(val expr: BuildConstraintExpression) : BuildConstraintExpression

A simple parenthesis around a build constraint, which can be used to logically group expressions.

BuildConstraintTag

class BuildConstraintTag(val tag: String) : BuildConstraintExpression

The usage of a tag as a build constraint expression. This is the simplest form of expression and will return true if the tag is contained in the list of available tags.

BuildConstraintUnaryExpression

class BuildConstraintUnaryExpression(val operatorCode: String, val expr: BuildConstraintExpression) : BuildConstraintExpression

A unary build constraint expression. Currently, only ! as operatorCode for a negation is supported.

DeclarationHandler

class DeclarationHandler(frontend: GoLanguageFrontend) : GoHandler<Declaration?, GoStandardLibrary.Ast.Decl>

ExpressionHandler

class ExpressionHandler(frontend: GoLanguageFrontend) : GoHandler<Expression, GoStandardLibrary.Ast.Expr>

GoHandler

abstract class GoHandler<ResultNode : Node?, HandlerNode : GoStandardLibrary.Ast.Node>(configConstructor: Supplier<ResultNode?>, lang: GoLanguageFrontend) : Handler<ResultNode?, HandlerNode, GoLanguageFrontend>

GoLanguage

class GoLanguage : Language<GoLanguageFrontend> , HasShortCircuitOperators, HasGenerics, HasStructs, HasFirstClassFunctions, HasAnonymousIdentifier, HasFunctionStyleCasts

The Go language.

GoLanguageFrontend

class GoLanguageFrontend(language: Language<GoLanguageFrontend>, ctx: TranslationContext) : LanguageFrontend<GoStandardLibrary.Ast.Node, GoStandardLibrary.Ast.Expr>

A language frontend for the GoLanguage. It makes use the internal go/ast package of the Go runtime to parse the AST of a Go program. We make use of JNA to call a dynamic library which exports C function wrappers around the Go API. This is needed because we cannot directly export Go structs and pointers to C.

GoStandardLibrary

interface GoStandardLibrary : Library

This interface represents parts of the Go standard library used by C wrapper functions and JNA.

SpecificationHandler

class SpecificationHandler(frontend: GoLanguageFrontend) : GoHandler<Declaration?, GoStandardLibrary.Ast.Spec>

StatementHandler

class StatementHandler(frontend: GoLanguageFrontend) : GoHandler<Statement, GoStandardLibrary.Ast.Stmt>

Properties

embeddedStructs

val RecordDeclaration.embeddedStructs: List<RecordDeclaration>

isChannel

val Type.isChannel: Boolean

isInterface

val Type.isInterface: Boolean

isMap

val Type.isMap: Boolean

isNil

val HasType?.isNil: Boolean

namedType

val Type?.namedType: Boolean

In Go, types can be constructed based on existing types (see underlyingType) and if given a name, they are considered a named type.

underlyingType

val Type?.underlyingType: Type?

Go has the concept of the underlying type, in which new named types can be created on top of existing core types (such as function types, slices, etc.). The named types then derive certain properties of their underlying type.

Functions

funcTypeName

fun funcTypeName(paramTypes: List<Type>, returnTypes: List<Type>): String

This function produces a Go-style function type name such as func(int, string) string or func(int) (error, string)

list

fun <T : PointerType, S : PointerType> T.list(numFunc: (T) -> Int, itemFunc: (T, Int) -> S): MutableList<S>