LARA Documentation

ANTAREX API

antarex.examon.Examon
antarex.examon.ExamonAspects
antarex.inline.inlineAspects
antarex.inline.inlineFuncs
antarex.libvc.LibVC
antarex.margot.codegen.MargotCodeGen
antarex.margot.config.MargotBlock
antarex.margot.config.MargotConfig
antarex.margot.config.MargotDataFeature
antarex.margot.config.MargotEnergyDomain
antarex.margot.config.MargotKnob
antarex.margot.config.MargotState
antarex.margot.config.monitor.MargotCustomMonitor
antarex.margot.config.monitor.MargotEnergyMonitor
antarex.margot.config.monitor.MargotMonitor
antarex.margot.config.monitor.MargotThroughputMonitor
antarex.margot.config.monitor.MargotTimeMonitor
antarex.margot.dse.MargotDseInfo
antarex.margot.dse.metric.MargotMetric
antarex.memoi.Memoization
antarex.memoi.MemoizationAutoAspects
antarex.memoi.MemoizationAutoFuncs
antarex.memoi.MemoizationC
antarex.memoi.MemoizationCXX
antarex.memoi.MemoizationLibFuncs
antarex.memoi.MemoizationMath
antarex.multi.MultiVersionPointers
antarex.multi.MultiVersionPointersAspects
antarex.precision.CustomPrecision
antarex.precision.CustomPrecisionFunc
antarex.precision.rewTypes
antarex.precision.rewTypesFunc
antarex.split.extractCodeAspects
antarex.split.extractCodeFuncs
antarex.split.splitDeclarations
antarex.split.splitLoopAspects
antarex.split.splitLoopFuncs
antarex.utils.IdentReferences
antarex.utils.lowLevelFuncs
antarex.utils.mangling
antarex.utils.messages
antarex.utils.sysfile

Clava API

clava.Clava
clava.ClavaCode
clava.ClavaJoinPoints
clava.ClavaNodes
clava.ClavaType
clava.analysis.analysers.BoundsAnalyser
clava.analysis.analysers.BoundsResult
clava.analysis.analysers.DoubleFreeAnalyser
clava.analysis.analysers.DoubleFreeResult
clava.analysis.checkers.ChgrpChecker
clava.analysis.checkers.ChmodChecker
clava.analysis.checkers.ChownChecker
clava.analysis.checkers.CinChecker
clava.analysis.checkers.ExecChecker
clava.analysis.checkers.FprintfChecker
clava.analysis.checkers.FscanfChecker
clava.analysis.checkers.GetsChecker
clava.analysis.checkers.LambdaChecker
clava.analysis.checkers.MemcpyChecker
clava.analysis.checkers.PrintfChecker
clava.analysis.checkers.ScanfChecker
clava.analysis.checkers.SprintfChecker
clava.analysis.checkers.StrcatChecker
clava.analysis.checkers.StrcpyChecker
clava.analysis.checkers.SyslogChecker
clava.analysis.checkers.SystemChecker
clava.autopar.AddOpenMPDirectivesForLoop
clava.autopar.AddPragmaLoopIndex
clava.autopar.AutoParStats
clava.autopar.AutoParUtils
clava.autopar.BuildPetitFileInput
clava.autopar.CheckForSafeFunctionCall
clava.autopar.ExecPetitDependencyTest
clava.autopar.FindReductionArrays
clava.autopar.InlineFunctionCalls
clava.autopar.LoopInductionVariables
clava.autopar.NormalizedBinaryOp
clava.autopar.OmegaConfig
clava.autopar.Parallelize
clava.autopar.ParallelizeLoop
clava.autopar.RemoveNakedloops
clava.autopar.RemoveOpenMPfromInnerloop
clava.autopar.RunInlineFunctionCalls
clava.autopar.SetArrayAccessOpenMPscoping
clava.autopar.SetMemberAccessOpenMPscoping
clava.autopar.SetVariableAccess
clava.autopar.SetVarrefOpenMPscoping
clava.autopar.additionalConditionsCheck
clava.autopar.checkForFunctionCalls
clava.autopar.checkForInvalidStmts
clava.autopar.checkForOpenMPCanonicalForm
clava.autopar.checkvarreReduction
clava.autopar.get_varTypeAccess
clava.code.DecomposeResult
clava.code.DoToWhileStmt
clava.code.ForToWhileStmt
clava.code.GlobalVariable
clava.code.Inliner
clava.code.Outliner
clava.code.RemoveShadowing
clava.code.SimplifyAssignment
clava.code.SimplifyTernaryOp
clava.code.StatementDecomposer
clava.gprofer.Gprofer
clava.graphs.ControlFlowGraph
clava.graphs.StaticCallGraph
clava.graphs.cfg.CfgBuilder
clava.graphs.cfg.CfgEdge
clava.graphs.cfg.CfgEdgeType
clava.graphs.cfg.CfgNodeData
clava.graphs.cfg.CfgNodeType
clava.graphs.cfg.CfgUtils
clava.graphs.cfg.NextCfgNode
clava.graphs.cfg.nodedata.DataFactory
clava.graphs.cfg.nodedata.HeaderData
clava.graphs.cfg.nodedata.IfData
clava.graphs.cfg.nodedata.InstListNodeData
clava.graphs.cfg.nodedata.LoopData
clava.graphs.cfg.nodedata.ReturnData
clava.graphs.cfg.nodedata.ScopeNodeData
clava.graphs.scg.ScgEdgeData
clava.graphs.scg.ScgNodeData
clava.graphs.scg.StaticCallGraphBuilder
clava.hdf5.Hdf5
clava.hls.HLSAnalysis
clava.hls.MathAnalysis
clava.hls.MathHInfo
clava.hls.TraceInstrumentation
clava.memoi.MemoiAnalysis
clava.memoi.MemoiGen
clava.memoi.MemoiProf
clava.memoi.MemoiTarget
clava.memoi.MemoiUtils
clava.mpi.MpiAccessPattern
clava.mpi.MpiScatterGatherLoop
clava.mpi.MpiUtils
clava.mpi.patterns.IterationVariablePattern
clava.mpi.patterns.MpiAccessPatterns
clava.mpi.patterns.ScalarPattern
clava.opencl.KernelReplacer
clava.opencl.KernelReplacerAuto
clava.opencl.OpenCLCall
clava.opencl.OpenCLCallVariables
clava.opt.Inlining
clava.opt.NormalizeToSubset
clava.opt.PrepareForInlining
clava.parser.BatchParser
clava.pass.DecomposeDeclStmt
clava.pass.DecomposeVarDeclarations
clava.pass.LocalStaticToGlobal
clava.pass.SimplifyLoops
clava.pass.SimplifyReturnStmts
clava.pass.SimplifySelectionStmts
clava.pass.SingleReturnFunction
clava.stats.OpsBlock
clava.stats.OpsCost
clava.stats.OpsCounter
clava.stats.StaticOpsCounter
clava.util.ClavaDataStore
clava.util.CodeInserter
clava.util.FileIterator
clava.uve.DetectStream
clava.uve.UVE

LARA API

core
core.coretest
core.output
lara.Check
lara.Collections
lara.Compilation
lara.Csv
lara.Debug
lara.Io
lara.JavaInterop
lara.MathExtra
lara.Numbers
lara.Platforms
lara.Strings
lara.System
lara.analysis.Analyser
lara.analysis.AnalyserResult
lara.analysis.CheckBasedAnalyser
lara.analysis.CheckResult
lara.analysis.Checker
lara.analysis.Fix
lara.analysis.MessageGenerator
lara.analysis.ResultFormatManager
lara.analysis.ResultList
lara.benchmark.BenchmarkInstance
lara.benchmark.BenchmarkSet
lara.benchmark.ClavaBenchmarkInstance
lara.cmake.CMaker
lara.cmake.CMakerSources
lara.cmake.CMakerUtils
lara.cmake.compilers.CMakeCompiler
lara.cmake.compilers.GenericCMakeCompiler
lara.code.Energy
lara.code.Logger
lara.code.Timer
lara.core.JavaTypes
lara.core.LaraCore
lara.core.output
lara.dse.DseLoop
lara.dse.DseValues
lara.dse.DseValuesList
lara.dse.DseValuesSet
lara.dse.DseVariant
lara.dse.VariableVariant
lara.graphs.DotFormatter
lara.graphs.EdgeData
lara.graphs.GraphEdge
lara.graphs.GraphNode
lara.graphs.Graphs
lara.graphs.NodeData
lara.iterators.LaraIterator
lara.iterators.LineIterator
lara.metrics.EnergyMetric
lara.metrics.ExecutionTimeMetric
lara.metrics.FileSizeMetric
lara.metrics.Metric
lara.metrics.MetricResult
lara.mutation.IterativeMutation
lara.mutation.IterativeMutator
lara.mutation.Mutation
lara.mutation.MutationResult
lara.mutation.Mutator
lara.pass.AdapterPass
lara.pass.Pass
lara.pass.PassTransformationError
lara.pass.SimplePass
lara.pass.composition.PassApplyArg
lara.pass.composition.Passes
lara.pass.results.AggregatePassResult
lara.pass.results.PassResult
lara.tool.Tool
lara.tool.ToolUtils
lara.units.EnergyUnit
lara.units.SiModifier
lara.units.SiUnit
lara.units.TimeModifier
lara.units.TimeUnit
lara.units.Unit
lara.units.UnitModifier
lara.units.UnitWithModifier
lara.util.AbstractClassError
lara.util.Accumulator
lara.util.Checkpoint
lara.util.Combinations
lara.util.DataStore
lara.util.IdGenerator
lara.util.JavaTypes
lara.util.JpFilter
lara.util.LineInserter
lara.util.LocalFolder
lara.util.PredefinedStrings
lara.util.PrintOnce
lara.util.ProcessExecutor
lara.util.Replacer
lara.util.SequentialCombinations
lara.util.StringSet
lara.util.TimeUnits
lara.util.TupleId
lara.vitishls.VitisHls
lara.vitishls.VitisHlsReportParser
lara.vitishls.VitisHlsUtils
weaver.Ast
weaver.JoinPoints
weaver.Query
weaver.Script
weaver.Selector
weaver.TraversalType
weaver.Weaver
weaver.WeaverJps
weaver.WeaverLauncher
weaver.WeaverOptions
weaver.jp.ClavaBinaryJp
weaver.jp.ClavaCallJp
weaver.jp.ClavaClassJp
weaver.jp.ClavaClassTypeJp
weaver.jp.ClavaConstructorCallJp
weaver.jp.ClavaConstructorJp
weaver.jp.ClavaDeclJp
weaver.jp.ClavaElseJp
weaver.jp.ClavaFieldJp
weaver.jp.ClavaFieldRefJp
weaver.jp.ClavaFileJp
weaver.jp.ClavaFunctionJp
weaver.jp.ClavaIfJp
weaver.jp.ClavaInterfaceJp
weaver.jp.ClavaJoinPoint
weaver.jp.ClavaLoopJp
weaver.jp.ClavaMemberCallJp
weaver.jp.ClavaMethodJp
weaver.jp.ClavaParamJp
weaver.jp.ClavaTypeJp
weaver.jp.ClavaVarDeclJp
weaver.jp.ClavaVarRefJp
weaver.jp.CommonJoinPoints
weaver.util.ActionAwareCache
weaver.util.WeaverDataStore

LARA Common Language API

lcl.LaraCommonLanguage
lcl.metrics.Metric
lcl.metrics.Metrics
lcl.metrics.ck.CBO
lcl.metrics.ck.CKMetricsIndex
lcl.metrics.ck.DIT
lcl.metrics.ck.LCOM94
lcl.metrics.ck.NOC
lcl.metrics.ck.RFC
lcl.metrics.ck.WMC
lcl.metrics.lh.DAC
lcl.metrics.lh.LHMetricsIndex
lcl.metrics.lh.MPC
lcl.metrics.lh.NOM
lcl.metrics.lh.SIZE1
lcl.metrics.lh.SIZE2
lcl.metrics.om.CogniComplex
lcl.metrics.om.CycloComplex
lcl.metrics.om.LOC
lcl.metrics.om.NOCl
lcl.metrics.om.NOFi
lcl.metrics.om.NOFu
lcl.metrics.om.NOL
lcl.metrics.om.OtherMetricsIndex
lcl.ml.Code2Vec
lcl.patterns.DetectionAlgorithm
lcl.patterns.PatternsReader
lcl.patterns.grouping.GroupingUtils

(.js)
laraImport("antarex.utils.mangling");

(.lara)
import antarex.utils.mangling;

Global Functions:

getMangledName
getManglingForC
setManglingForC

Global Functions

getMangledName

getMangledName(vfile, includes, name, ccompiler)

Parameters

vfile: any
includes: any
name: any
ccompiler: any

Returns

any - the mangled name of name defined in a file (vfile). The compiling of vfile requires some includes (includes array of strings). Restricted to Linux currently.

getManglingForC

getManglingForC()

Returns

any - the value of the mangling mode for C, set by a call to the manglingForC function (default false). When this value is true, it specifies that the mangling is required for C code.

setManglingForC

setManglingForC(when, b)

Set the mangling for C mode.

Parameters

when: boolean - true the mangling for C function name is activated, not activated otherwise. It must be activated when a C code is compiled with a C++ compiler.
b: any