codyze-core/de.fraunhofer.aisec.codyze.core.plugin/Plugin

Plugin

abstract class Plugin(cliName: String) : NoOpCliktCommand(source)

Plugins perform a standalone analysis independent of the Codyze Executors. They usually use already developed libraries from open-source analysis tools. When developing a new Plugin, do not forget to add it to the respective KoinModules, otherwise it will not be selectable in the configuration. Also, remember to add a page to docs/plugins.

Constructors

Plugin

constructor(cliName: String)

Properties

commandHelp

open val ~~commandHelp~~: String

commandHelpEpilog

open val ~~commandHelpEpilog~~: String

commandName

val commandName: String

currentContext

val currentContext: Context

helpTags

val helpTags: Map<String, String>

invokeWithoutSubcommand

val invokeWithoutSubcommand: Boolean

messages

val messages: List<String>

printHelpOnEmptyArgs

val printHelpOnEmptyArgs: Boolean

Functions

aliases

open fun aliases(): Map<String, List<String>>

allHelpParams

open fun allHelpParams(): List<HelpFormatter.ParameterHelp>

commandHelp

open fun commandHelp(context: Context): String

commandHelpEpilog

open fun commandHelpEpilog(context: Context): String

confirm

fun ~~confirm~~(text: String, default: Boolean?, uppercaseDefault: Boolean, showChoices: Boolean, choiceStrings: List<String>, promptSuffix: String, invalidChoiceMessage: String): Boolean?

echo

fun echo()

fun echo(message: Any?, trailingNewline: Boolean, err: Boolean)

echoFormattedHelp

fun echoFormattedHelp(error: CliktError?)

equals

open operator override fun equals(other: Any?): Boolean

Define two plugins as equal if they are of the same type and therefore have the same CLI name. This is necessary to filter out duplicate Plugins when parsing the cli arguments

execute

abstract fun execute(target: List<Path>, context: List<Path>, output: File)

Executes the respective analysis tool.

getFormattedHelp

fun getFormattedHelp(error: CliktError?): String?

hashCode

open override fun hashCode(): Int

issueMessage

fun issueMessage(message: String)

main

fun main(argv: Array<out String>)

fun main(argv: List<String>)

module

abstract fun module(): Module

parse

fun parse(argv: Array<String>, parentContext: Context?)

fun parse(argv: List<String>, parentContext: Context?)

prompt

fun ~~prompt~~(text: String, default: String?, showDefault: Boolean, showChoices: Boolean, hideInput: Boolean, choices: Collection<String>, promptSuffix: String, invalidChoiceMessage: String): String?

fun <T> ~~prompt~~(text: String, default: T?, showDefault: Boolean, showChoices: Boolean, hideInput: Boolean, choices: Collection<T>, promptSuffix: String, invalidChoiceMessage: String, convert: (String) -> ConversionResult<T>): T?

registerArgument

fun registerArgument(argument: Argument)

registeredArguments