Kross::InterpreterInfo
#include <interpreter.h>
Classes | |
class | Option |
Public Member Functions | |
InterpreterInfo (const QString &interpretername, QFunctionPointer funcPtr, const QString &wildcard, const QStringList &mimetypes, const Option::Map &options=Option::Map()) | |
~InterpreterInfo () | |
bool | hasOption (const QString &name) const |
Interpreter * | interpreter () |
const QString | interpreterName () const |
const QStringList | mimeTypes () const |
Option * | option (const QString &name) const |
Option::Map & | options () |
const QVariant | optionValue (const QString &name, const QVariant &defaultvalue=QVariant()) const |
const QString | wildcard () const |
Detailed Description
The InterpreterInfo class provides abstract information about a Interpreter before the interpreter-backend itself is loaded.
Definition at line 61 of file core/interpreter.h.
Constructor & Destructor Documentation
◆ InterpreterInfo()
InterpreterInfo::InterpreterInfo | ( | const QString & | interpretername, |
QFunctionPointer | funcPtr, | ||
const QString & | wildcard, | ||
const QStringList & | mimetypes, | ||
const Option::Map & | options = Option::Map() |
||
) |
Constructor.
- Parameters
-
interpretername The name of the interpreter. The name is used internally as unique identifier for the interpreter and could be for example "python", "ruby" or "javascript". funcPtr A pointer to the entry function within the library. The entry function each interpreter-backend does provide looks like this; wildcard File wildcard that identifies a by the interpreter supported scripting files. As example Python does define here "*.py" while Java does define "*.java *.class". mimetypes The file mimetype that identifies a by the interpreter supported scripting files. As example Python does define "text/x-python" here while Ruby defines "application/x-ruby" and Java "application/java". options The optional list of options supported by the interpreter to configure the backend.
Definition at line 60 of file core/interpreter.cpp.
◆ ~InterpreterInfo()
InterpreterInfo::~InterpreterInfo | ( | ) |
Destructor.
Definition at line 71 of file core/interpreter.cpp.
Member Function Documentation
◆ hasOption()
bool InterpreterInfo::hasOption | ( | const QString & | name | ) | const |
- Returns
- true if an Option with that
key
exists else false.
Definition at line 93 of file core/interpreter.cpp.
◆ interpreter()
Interpreter * InterpreterInfo::interpreter | ( | ) |
- Returns
- the Interpreter instance this InterpreterInfo is the describer for. If the interpreter that implements the scripting backend isn't loaded yet, this method will trigger the loading of the interpreter's library. Note that this method may return NULL if there is no library for that interpreter installed or if the library is incompatible.
Definition at line 113 of file core/interpreter.cpp.
◆ interpreterName()
const QString InterpreterInfo::interpreterName | ( | ) | const |
- Returns
- the name of the interpreter. For example "python" or "ruby".
Definition at line 78 of file core/interpreter.cpp.
◆ mimeTypes()
const QStringList InterpreterInfo::mimeTypes | ( | ) | const |
List of mimetypes this interpreter supports.
- Returns
- QStringList with mimetypes like "application/javascript".
Definition at line 88 of file core/interpreter.cpp.
◆ option()
InterpreterInfo::Option * InterpreterInfo::option | ( | const QString & | name | ) | const |
- Returns
- the option defined with
name
.
Definition at line 98 of file core/interpreter.cpp.
◆ options()
InterpreterInfo::Option::Map & InterpreterInfo::options | ( | ) |
- Returns
- the reference to the intenal used map with all options.
Definition at line 103 of file core/interpreter.cpp.
◆ optionValue()
const QVariant InterpreterInfo::optionValue | ( | const QString & | name, |
const QVariant & | defaultvalue = QVariant() |
||
) | const |
- Returns
- the value of the option defined with
name
. If there doesn't exists an option with such a name, thedefaultvalue
is returned.
Definition at line 108 of file core/interpreter.cpp.
◆ wildcard()
const QString InterpreterInfo::wildcard | ( | ) | const |
- Returns
- the file-wildcard used to determinate by this interpreter used scriptingfiles. For example python just defines it as "*py".
Definition at line 83 of file core/interpreter.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Tue Dec 5 2023 04:09:32 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.