You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
287 lines
7.4 KiB
287 lines
7.4 KiB
/**************************************************************************
|
|
* Copyright (C) 2006, 2007 by Michel Ludwig (michel.ludwig@kdemail.net) *
|
|
***************************************************************************/
|
|
|
|
/**************************************************************************
|
|
* *
|
|
* This program is free software; you can redistribute it and/or modify *
|
|
* it under the terms of the GNU General Public License as published by *
|
|
* the Free Software Foundation; either version 2 of the License, or *
|
|
* (at your option) any later version. *
|
|
* *
|
|
***************************************************************************/
|
|
|
|
#ifndef KILEJSCRIPT_H
|
|
#define KILEJSCRIPT_H
|
|
|
|
#include <tqmap.h>
|
|
#include <tqobject.h>
|
|
|
|
#include <kjs/interpreter.h>
|
|
#include <kjs/object.h>
|
|
|
|
#include <tdeaction.h>
|
|
#include <tdeconfig.h>
|
|
#include <kdirwatch.h>
|
|
|
|
#include <tqvaluelist.h>
|
|
#include <tqvaluevector.h>
|
|
|
|
class KileInfo;
|
|
|
|
namespace KileJScript {
|
|
|
|
/**
|
|
* This class represents a JavaScript script.
|
|
**/
|
|
class JScript {
|
|
public:
|
|
/**
|
|
* Constructs a new JavaScript script.
|
|
* @param file the file that contains the script
|
|
**/
|
|
JScript(unsigned int id, const TQString& file);
|
|
|
|
/**
|
|
* Returns the code of this script, i.e. the file is read and its contents are
|
|
* returned.
|
|
**/
|
|
TQString getCode() const;
|
|
|
|
/**
|
|
* Returns the name of the script (the base name of the file).
|
|
**/
|
|
TQString getName() const;
|
|
|
|
/**
|
|
* Returns the file of the script (the full path, including the base name).
|
|
**/
|
|
TQString getFileName() const;
|
|
|
|
/**
|
|
* Returns the unique identifier of this script.
|
|
**/
|
|
unsigned int getID() const;
|
|
|
|
/**
|
|
* Sets the unique identifier of this script.
|
|
**/
|
|
void setID(unsigned int id);
|
|
|
|
|
|
/**
|
|
*
|
|
**/
|
|
void setActionObject(TDEAction* action);
|
|
|
|
const TDEAction* getActionObject() const;
|
|
|
|
TDEAction* getActionObject();
|
|
|
|
void setKeySequence(const TQString& str);
|
|
TQString getKeySequence() const;
|
|
|
|
protected:
|
|
unsigned int m_id;
|
|
TQString m_code;
|
|
TQString m_file;
|
|
TQString m_name;
|
|
TDEAction *m_action;
|
|
TQString m_keySequence;
|
|
};
|
|
|
|
/**
|
|
* This class represents the JavaScript environment that is used to execute Kile's scripts
|
|
* in.
|
|
**/
|
|
class JScriptEnvironment {
|
|
public:
|
|
/**
|
|
* Constructs a new environment.
|
|
**/
|
|
JScriptEnvironment(KileInfo *kileInfo);
|
|
~JScriptEnvironment();
|
|
|
|
/**
|
|
* Executes JavaScript code in this environment.
|
|
* @param c the code that should be executed
|
|
**/
|
|
void execute(const TQString& c);
|
|
|
|
protected:
|
|
KJS::Interpreter *m_interpreter;
|
|
KJS::Object* m_kileJSObject;
|
|
KileInfo *m_kileInfo;
|
|
};
|
|
|
|
/**
|
|
* This class handles the scripting functionality in Kile.
|
|
**/
|
|
class Manager : public TQObject {
|
|
Q_OBJECT
|
|
|
|
|
|
public:
|
|
/**
|
|
* Constructs a new Manager object.
|
|
**/
|
|
Manager(KileInfo *info, TDEConfig *config, TDEActionCollection *actionCollection, TQObject *parent = 0, const char *name = 0);
|
|
virtual ~Manager();
|
|
|
|
/**
|
|
* Executes a script in Kile's scripting environment.
|
|
* @param script the script that should be executed
|
|
**/
|
|
void executeJScript(const JScript *script);
|
|
|
|
/**
|
|
* Executes a script in Kile's scripting environment.
|
|
* @param id the id of the script that should be executed
|
|
**/
|
|
void executeJScript(unsigned int id);
|
|
|
|
/**
|
|
* Retrieves a list of all the scripts that are currently available.
|
|
**/
|
|
TQValueList<JScript*> getJScripts();
|
|
|
|
/**
|
|
* Writes the key sequence-to-script bindings to the TDEConfig object that has
|
|
* passed in the constructor.
|
|
**/
|
|
void writeConfig();
|
|
|
|
/**
|
|
* Assigns a key sequence to a script. If the parameter "keySequence" is empty,
|
|
* then nothing is done.
|
|
* @param script the script that is considered
|
|
* @param keySequence the key sequence that is assigned
|
|
**/
|
|
void setEditorKeySequence(JScript* script, const TQString& keySequence);
|
|
|
|
/**
|
|
* Removes an assigned key sequence from a script.
|
|
* @param script the script that is considered
|
|
**/
|
|
void removeEditorKeySequence(JScript* script);
|
|
|
|
/**
|
|
* Returns the directory that can be used by the used to store Kile's scripts.
|
|
* Usually $HOME/.trinity/share/apps/kile/scripts
|
|
**/
|
|
TQString getLocalJScriptDirectory() const;
|
|
|
|
/**
|
|
* Returns the script object that corresponds to a script id.
|
|
* @param id the id of the script
|
|
**/
|
|
const JScript* getScript(unsigned int id);
|
|
|
|
signals:
|
|
/**
|
|
* Signal emitted whenever the managed scripts haved changed, for example if the
|
|
* watched directories have been scanned for scripts and thus, the potentially
|
|
* available scripts (could) have changed.
|
|
* The signal is also emitted when the currently available scripts have been
|
|
* deleted internally in Kile (for example, after disabling the scripting feature).
|
|
**/
|
|
void jScriptsChanged();
|
|
|
|
public slots:
|
|
/**
|
|
* Does nothing if scripting has been disabled.
|
|
**/
|
|
void scanJScriptDirectories();
|
|
|
|
/**
|
|
* Reads and assigns the key sequence-to-script bindings from the TDEConfig
|
|
* object that has been passed in the constructor.
|
|
**/
|
|
void readConfig();
|
|
|
|
protected:
|
|
TQString m_localJScriptDir;
|
|
TQValueList<JScript*> m_jScriptList;
|
|
TQMap<unsigned int, JScript*> m_idScriptMap;
|
|
KDirWatch *m_jScriptDirWatch;
|
|
|
|
KileInfo *m_kileInfo;
|
|
TDEConfig *m_config;
|
|
TDEActionCollection *m_actionCollection;
|
|
|
|
/**
|
|
* Registers the script contained in a file.
|
|
* @param fileName the file that contains the script
|
|
**/
|
|
void registerScript(const TQString& fileName, TQMap<TQString, unsigned int>& pathIDMap, TQMap<unsigned int, bool>& takenIDMap, unsigned int &maxID);
|
|
|
|
/**
|
|
* (Re-)Creates and initialises the KDirWatch object.
|
|
**/
|
|
void populateDirWatch();
|
|
|
|
/**
|
|
* Deletes all the scripts that are handled by this manager.
|
|
**/
|
|
void deleteJScripts();
|
|
|
|
/**
|
|
* Reads an 'unsigned int' list as value for a specific key from the local TDEConfig
|
|
* object.
|
|
* @param key the considered entry key
|
|
**/
|
|
TQValueList<unsigned int> readUnsignedIntListEntry(const TQString& key);
|
|
|
|
/**
|
|
* Writes a key - value pair to the local TDEConfig object for the case that the
|
|
* value is an 'unsigned int' list.
|
|
* @param key the considered entry key
|
|
* @param l the 'unsigned int' list that is used as value
|
|
**/
|
|
void writeEntry(const TQString& key, const TQValueList<unsigned int>& l);
|
|
|
|
/**
|
|
* Finds the next free ID.
|
|
* @param takenIDMap map describing which IDs are already in use
|
|
* @param maxID the maximum ID that is currently in use (if there is no ID assigned, then
|
|
* any value can be passed here, but typically '0')
|
|
**/
|
|
unsigned int findFreeID(const TQMap<unsigned int, bool>& takenIDMap, unsigned int maxID);
|
|
|
|
/**
|
|
* Writes the ID to file name mappings that are currently in use to the local
|
|
* TDEConfig object.
|
|
**/
|
|
void writeIDs();
|
|
|
|
private:
|
|
/**
|
|
* Recursively adds a directory to a KDirWatch object.
|
|
* @param dir the directory that should be added
|
|
**/
|
|
void addDirectoryToDirWatch(const TQString& dir);
|
|
};
|
|
|
|
class ScriptExecutionAction : public TDEAction {
|
|
Q_OBJECT
|
|
|
|
|
|
public:
|
|
ScriptExecutionAction(unsigned int scriptID, Manager *manager, TDEActionCollection* parent = 0);
|
|
|
|
virtual ~ScriptExecutionAction();
|
|
|
|
protected slots:
|
|
void executeScript();
|
|
|
|
protected:
|
|
KileJScript::Manager *m_manager;
|
|
unsigned int m_id;
|
|
};
|
|
|
|
|
|
}
|
|
|
|
#endif
|
|
|