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.
tdeaccessibility/kttsd/libkttsd/pluginconf.cpp

246 lines
9.3 KiB

/*
This file is the templates for the configuration plug ins.
-------------------
Copyright : (C) 2002-2003 by José Pablo Ezequiel "Pupeno" Fernández
-------------------
Original author: José Pablo Ezequiel "Pupeno" Fernández <pupeno@kde.org>
Current Maintainer: Gary Cramblitt <garycramblitt@comcast.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; version 2 of the License. *
* *
***************************************************************************/
// C++ library includes.
#include <stdlib.h>
#include <sys/param.h>
// TQt includes.
#include <tqfile.h>
#include <tqfileinfo.h>
#include <tqstring.h>
// KDE includes.
#include <tdeglobal.h>
#include <tdelocale.h>
#include <kstandarddirs.h>
// PluginConf includes.
#include "pluginconf.h"
#include "pluginconf.moc"
/**
* Constructor
*/
PlugInConf::PlugInConf( TQWidget *parent, const char *name) : TQWidget(parent, name){
kdDebug() << "PlugInConf::PlugInConf: Running" << endl;
TDEGlobal::locale()->insertCatalogue("kttsd");
TQString systemPath(getenv("PATH"));
// kdDebug() << "Path is " << systemPath << endl;
m_path = TQStringList::split(":", systemPath);
m_player = 0;
}
/**
* Destructor.
*/
PlugInConf::~PlugInConf(){
kdDebug() << "PlugInConf::~PlugInConf: Running" << endl;
delete m_player;
}
/**
* This method is invoked whenever the module should read its
* configuration (most of the times from a config file) and update the
* user interface. This happens when the user clicks the "Reset" button in
* the control center, to undo all of his changes and restore the currently
* valid settings. Note that kttsmgr calls this when the plugin is
* loaded, so it not necessary to call it in your constructor.
* The plugin should read its configuration from the specified group
* in the specified config file.
* @param config Pointer to a TDEConfig object.
* @param configGroup Call config->setGroup with this argument before
* loading your configuration.
*/
void PlugInConf::load(TDEConfig* /*config*/, const TQString& /*configGroup*/){
kdDebug() << "PlugInConf::load: Running" << endl;
}
/**
* This function gets called when the user wants to save the settings in
* the user interface, updating the config files or wherever the
* configuration is stored. The method is called when the user clicks "Apply"
* or "Ok". The plugin should save its configuration in the specified
* group of the specified config file.
* @param config Pointer to a TDEConfig object.
* @param configGroup Call config->setGroup with this argument before
* saving your configuration.
*/
void PlugInConf::save(TDEConfig* /*config*/, const TQString& /*configGroup*/){
kdDebug() << "PlugInConf::save: Running" << endl;
}
/**
* This function is called to set the settings in the module to sensible
* default values. It gets called when hitting the "Default" button. The
* default values should probably be the same as the ones the application
* uses when started without a config file. Note that defaults should
* be applied to the on-screen widgets; not to the config file.
*/
void PlugInConf::defaults(){
kdDebug() << "PlugInConf::defaults: Running" << endl;
}
/**
* Indicates whether the plugin supports multiple instances. Return
* False if only one instance of the plugin can run at a time.
* @return True if multiple instances are possible.
*
* It is assumed that most plugins can support multiple instances.
* A plugin must override this method and return false if it
* cannot support multiple instances.
*/
bool PlugInConf::supportsMultiInstance() { return true; }
/**
* This function informs the plugin of the desired language to be spoken
* by the plugin. The plugin should attempt to adapt itself to the
* specified language code, choosing sensible defaults if necessary.
* If the passed-in code is TQString(), no specific language has
* been chosen.
* @param lang The desired language code or Null if none.
*
* If the plugin is unable to support the desired language, that is OK.
*/
void PlugInConf::setDesiredLanguage(const TQString& /*lang*/ ) { }
/**
* Return fully-specified talker code for the configured plugin. This code
* uniquely identifies the configured instance of the plugin and distinquishes
* one instance from another. If the plugin has not been fully configured,
* i.e., cannot yet synthesize, return TQString().
* @return Fully-specified talker code.
*/
TQString PlugInConf::getTalkerCode() { return TQString(); }
/**
* Return a list of all the languages currently supported by the plugin.
* Note that as the user configures your plugin, the language choices may become
* narrower. For example, once the user has picked a voice file, the language
* may be determined. If your plugin has just been added and no configuration
* choices have yet been made, return a list of all possible languages the
* plugin might support.
* If your plugin cannot yet determine the languages supported, return Null.
* If your plugin can support any language, return Null.
* @return A TQStringList of supported language codes, or Null if unknown.
*/
TQStringList PlugInConf::getSupportedLanguages() { return TQStringList(); }
/**
* Return the full path to any program in the $PATH environmental variable
* @param name The name of the file to search for.
* @returns The path to the file on success, a blank TQString
* if its not found.
*/
TQString PlugInConf::getLocation(const TQString &name) {
// Iterate over the path and see if 'name' exists in it. Return the
// full path to it if it does. Else return an empty TQString.
// If it's a file or a symlink pointing to a file, that's cool.
TQFileInfo fileinfo(name);
if (fileinfo.isFile() || (fileinfo.isSymLink() && TQFileInfo(fileinfo.readLink()).isFile()))
return name;
kdDebug() << "PluginConf::getLocation: Searching for " << name << " in the path.." << endl;
kdDebug() << m_path << endl;
for(TQStringList::iterator it = m_path.begin(); it != m_path.end(); ++it) {
TQString fullName = *it;
fullName += "/";
fullName += name;
fileinfo.setFile(fullName);
// The user either has the directory of the file in the path...
if(fileinfo.isFile() || (fileinfo.isSymLink() && TQFileInfo(fileinfo.readLink()).isFile())) {
return fullName;
// kdDebug() << "PluginConf:getLocation: " << fullName << endl;
}
// ....Or the file itself in the path (slightly freaky but hey.)
else if(TQFileInfo(*it).baseName().append(TQString(".").append(TQFileInfo(*it).extension())) == name) {
return fullName;
// kdDebug() << "PluginConf:getLocation: " << fullName << endl;
}
}
return "";
}
/**
* Breaks a language code into the language code and country code (if any).
* @param languageCode Language code.
* @return countryCode Just the country code part (if any).
* @return Just the language code part.
*/
TQString PlugInConf::splitLanguageCode(const TQString& languageCode, TQString& countryCode)
{
TQString locale = languageCode;
TQString langCode;
TQString charSet;
TDEGlobal::locale()->splitLocale(locale, langCode, countryCode, charSet);
return langCode;
}
/*static*/ TQString PlugInConf::realFilePath(const TQString &filename)
{
char realpath_buffer[MAXPATHLEN + 1];
memset(realpath_buffer, 0, MAXPATHLEN + 1);
/* If the path contains symlinks, get the real name */
if (realpath( TQFile::encodeName(filename).data(), realpath_buffer) != 0) {
// succes, use result from realpath
return TQFile::decodeName(realpath_buffer);
}
return filename;
}
/*static*/ TQString PlugInConf::testMessage(const TQString& languageCode)
{
TQString key = "Name[" + languageCode + "]";
TQString result;
TQString def;
TQFile file(locate("data", "kttsd/kcmkttsd_testmessage.desktop"));
if (file.open(IO_ReadOnly))
{
TQTextStream stream(&file);
stream.setEncoding(TQTextStream::UnicodeUTF8);
while ( !stream.atEnd() ) {
TQString line = stream.readLine(); // line of text excluding '\n'
TQStringList keyAndValue = TQStringList::split("=", line);
if (keyAndValue.count() == 2)
{
if (keyAndValue[0] == key)
{
result = keyAndValue[1];
break;
}
if (keyAndValue[0] == "Name") def = keyAndValue[1];
}
}
file.close();
}
if (result.isEmpty())
{
result = def;
if (result.isEmpty()) result = "The text-to-speech system seems to be functioning properly.";
}
return result;
}
/**
* Player object that can be used by the plugin for testing playback of synthed files.
*/
void PlugInConf::setPlayer(TestPlayer* player) { m_player = player; }
TestPlayer* PlugInConf::getPlayer() { return m_player; }