ZConf::GUI - A GUI backend chooser.
Index
Code Index:
NAME
ZConf::GUI - A GUI backend chooser.
VERSION
SYNOPSIS
use ZConf::GUI;
my $zg = ZConf::GUI->new();
...
METHODS
new
This initiates it.
One arguement is taken.
If this errors, it errors permanently.
hash args
zconf
A already initialized ZConf object.
my $zg=ZConf::GUI->new({ zconf=>$zconf });
if($zg->{error}){
print "Error!\n";
}
getAppendOthers
This gets the value for 'appendOthers'.
my $appendOthers=$zg->getAppendOthers;
if($zg->{error}){
print "Error!\n";
}
getPreferred
This gets the preferred for a module.
my @prefs=$zg->getPreferred('ZConf::Runner');
if($zg->{error}){
print "Error!\n";
}
getSet
This gets what the current set is.
my $set=$zg->getSet;
if($zg->{error}){
print "Error!\n";
}
getUseX
This fetches if X should be used or not for a module.
$zcgui->getUseX('ZConf::Runner');
if($zcgui->{error}){
print "Error!";
}
hasPreferred
This checks to make sure a module has any prefences or not. The
returned value is a perl bolean value.
my $returned=$zg->hasPreferred("ZConf::BGSet");
init
This initializes it or a new set.
If the specified set already exists, it will be reset.
One arguement is required and it is the name of the set. If
it is not defined, ZConf will use the default one.
#creates a new set named foo
$zcw->init('foo');
if($zg->{error}){
print "Error!\n";
}
#creates a new set with ZConf choosing it's name
$zg->init();
if($zg->{error}){
print "Error!\n";
}
listAvailable
This is the available GUI modules for a module.
my @available=$zg->listAvailable('ZConf::Runner');
listModules
This lists configured modules.
my @modules=$zg->listModules;
if($zg->{error}){
print "Error!\n";
}
listSets
This lists the available sets.
my @sets=$zg->listSets;
if($zg->{error}){
print "Error!";
}
readSet
This reads a specific set. If the set specified
is undef, the default set is read.
#read the default set
$zg->readSet();
if($zg->{error}){
print "Error!\n";
}
#read the set 'someSet'
$zg->readSet('someSet');
if($zg->{error}){
print "Error!\n";
}
rmPreferred
This removes a the preferences for a module.
$zg->rmPreferred('ZConf::BGSet');
if($zg->{error}){
print "Error:".$self->{error}.":".$self->{errorString};
}
setAppendOthers
This sets the value for append others.
Only one value is accepted and that is a boolean
value.
$zg->setAppendOthers($boolean);
if($zg->{error}){
print "Error!\n";
}
setPreferred
This sets the preferred GUI back ends. The first arguement is the module.
The second is a array reference of the prefences.
my @prefs=('GUI', 'Curses');
#set it for ZConf::BGSet
my $zg->setPreferred('ZConf::BGSet', \@prefs);
setUseX
This determines if X should be used or not. This only affects terminal
related modules that respect this.
$zcgui->setUseX('ZConf::Runner', '1');
if($zcgui->{error}){
print "Error!";
}
termAvailable
This checks to see if a terminal is available. It checks
if $ENV{TERM} is set or not. If this is not set, it was most
likely not ran from with a terminal.
if($zg->termAvailable){
print "a terminal is available";
}else{
print "no terminal is available";
}
Xavailable
This checks if X is available. This is checked for by trying to run
'/bin/sh -c \'xhost 2> /dev/null > /dev/null\'' and is assumed if a
non-zero exit code is returned then it failed and thus X is not
available.
There is no reason to ever check $zcr->{error} with
this as this function will not set it. It just returns
a boolean value.
if($zg->Xavailable()){
print "X is available\n";
}
useX
This checks to see if a terminal interface should try to use X or not by
trying to spawn a X terminal.
This calls getUseX and if it is true, it calls Xavailable and returns it's
value.
my $useX=$zcgui->useX('ZConf::Runner');
which
This chooses which should be used. This returns all available
backends in order of preference.
my @choosen=$zg->which('ZConf::BGSet');
if($zg->{error}){
print "Error!";
}
print 'The primary preferred module is "'.$choosen[0].'"';
errorblank
This blanks the error storage and is only meant for internal usage.
It does the following.
$self->{error}=undef;
$self->{errorString}="";
ERROR CODES
1
ZConf error. Check $self->{zconf}->{error}.
2
3
No preferences specified.
4
A preference matched /:/.
5
No preferences for the listed module.
6
7
The specified module does not exist.
8
No value for what to set appendOthers to specified.
9
The value specified for appendOthers is not boolean.
ZConf Keys
These are stored in config 'gui'.
Each preference is stored as a string for a module. Each preference is seperated
as by ':'. The order of the preferred go from favorite to least favorite.
default
This is the default to use if nothing is setup for a module. The default value is
'GTK:Curses'.
appendOthers
If this is set to true, "1", when which is called, all the others will be appended after
the list of available preferred ones.
If this is not defined, it will default to true.
modules/*
This contains the a list of preferences for a module.
The module name is converted to a ZConf variable name by replacing '::' with '/'.
useX/*
This is if a cuses module should use X or not. If it is true, it will pass
If if is not defined, it is set to true.
The module name is converted to a ZConf variable name by replacing '::' with '/'.
USING ZConf::GUI
A backend is considered to be any thing directly under <module>::GUI. How to call it
or etc is directly up to the calling module though.
Any module using this, should have it's widgets and dialogs use a single hash for all it's
arguements. This is currently not a requirement, but will be in future versions for future
automated calling.
suggested methods
app
This initiates a application. If it is called, it is not expected to return.
hasApp
This quaries a module to check to see if it has a app.
dialogs
This returns a array of dialogs that can be called. These interupt execution till returned.
windows
This is a list of windows that can be created. These should return immediately after creating
the window.
AUTHOR
Zane C. Bowers, <vvelox at vvelox.net>
BUGS
Please report any bugs or feature requests to bug-zconf-gui at rt.cpan.org, or through
the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=ZConf-GUI. I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.
SUPPORT
You can find documentation for this module with the perldoc command.
perldoc ZConf::GUI
You can also look for information at:
- * RT: CPAN's request tracker
-
http://rt.cpan.org/NoAuth/Bugs.html?Dist=ZConf-GUI
- * AnnoCPAN: Annotated CPAN documentation
-
http://annocpan.org/dist/ZConf-GUI
- * CPAN Ratings
-
http://cpanratings.perl.org/d/ZConf-GUI
- * Search CPAN
-
http://search.cpan.org/dist/ZConf-GUI
ACKNOWLEDGEMENTS
COPYRIGHT & LICENSE
Copyright 2009 Zane C. Bowers, all rights reserved.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
package ZConf::GUI;
use warnings;
use strict;
use Module::List qw(list_modules);
use ZConf;
our $VERSION = '1.0.3';
sub new {
my %args;
if(defined($_[1])){
%args= %{$_[1]};
}
my $function='new';
my $self={error=>undef, errorString=>undef, module=>'ZConf-GUI', autoinit=>1, perror=>undef};
bless $self;
#this sets the set to undef if it is not defined
if (!defined($args{set})) {
$self->{set}=undef;
}else {
$self->{set}=$args{set};
}
if (!defined($args{zconf})) {
use ZConf;
$self->{zconf}=ZConf->new();
if(defined($self->{zconf}->{error})){
$self->{perror}=1;
$self->{error}=1;
$self->{errorString}="Could not initiate ZConf. It failed with '"
.$self->{zconf}->{error}."', '".
$self->{zconf}->{errorString}."'";
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return $self;
}
}else {
$self->{zconf}=$args{zconf};
}
#create the config if it does not exist
#if it does exist, make sure the set we are using exists
$self->{init} = $self->{zconf}->configExists("gui");
if($self->{zconf}->{error}){
$self->{perror}=1;
$self->{error}=1;
$self->{errorString}="Could not check if the config 'gu'i exists.".
" It failed with '".$self->{zconf}->{error}."', '"
.$self->{zconf}->{errorString}."'";
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return $self;
}
#this checks to make sure the set exists, if init is already 1
if ($self->{init}) {
$self->{init}=$self->{zconf}->defaultSetExists('gui', $self->{set});
if($self->{zconf}->{error}){
$self->{perror}=1;
$self->{error}=1;
$self->{errorString}="Could not check if the config 'gu'i exists.".
" It failed with '".$self->{zconf}->{error}."', '"
.$self->{zconf}->{errorString}."'";
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return $self;
}
}
#if it is not inited, check to see if it needs to do so
if ((!$self->{init}) && $self->{autoinit}) {
$self->init($self->{set});
if ($self->{error}) {
warn('ZConf-GUI new: Autoinit failed.');
}else {
#if init works, it is now inited and thus we set it to one
$self->{init}=1;
}
#we don't set any error stuff here even if the above action failed...
#it will have been set any ways by init methode
return $self;
}
#checks wether the specified set exists or not
$self->{init}=$self->{zconf}->setExists('gui', $self->{set});
if($self->{zconf}->{error}){
$self->{perror}=1;
$self->{error}=1;
$self->{errorString}="defaultSetExists failed for 'gui'.".
" It failed with '".$self->{zconf}->{error}."', '"
.$self->{zconf}->{errorString}."'";
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return $self;
}
#the first one does this if the config has not been done yet
#this one does it if the set has not been done yet
#if it is not inited, check to see if it needs to do so
if (!$self->{init} && $self->{autoinit}) {
$self->init($self->{set});
if ($self->{error}) {
$self->{perror}=1;
warn('ZConf-GUI new:4: Autoinit failed.');
}else {
#if init works, it is now inited and thus we set it to one
$self->{init}=1;
}
#we don't set any error stuff here even if the above action failed...
#it will have been set any ways by init methode
return $self;
}
#reads it if it does not need to be initiated
if ($self->{init}) {
$self->{zconf}->read({set=>$self->{set}, config=>'gui'});
}
return $self;
}
sub getAppendOthers{
my $self=$_[0];
my $function='getAppendOthers';
#blank all previous errors
$self->errorblank;
if ($self->{error}) {
warn($self->{module}.' '.$function.': A permanent error is set');
return undef;
}
#fetch the preferences for the module
my %vars=$self->{zconf}->regexVarGet('gui', '^appendOthers$');
if($self->{zconf}->{error}){
$self->{error}=1;
$self->{errorString}='ZConf error getting value "appendOthers" in "gui".'.
' ZConf error="'.$self->{zconf}->{error}.'" '.
'ZConf error string="'.$self->{zconf}->{errorString}.'"';
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
#if we don't have it, return true
if (!defined($vars{appendOthers})) {
return 1;
}
#return it's value
return $vars{appendOthers}
}
sub getPreferred{
my $self=$_[0];
my $module=$_[1];
my $function='getPreferred';
#blank all previous errors
$self->errorblank;
if ($self->{error}) {
warn($self->{module}.' '.$function.': A permanent error is set');
return undef;
}
if (!defined($module)) {
$self->{error}=2;
$self->{errorString}='No module specified';
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
#the change it for fetching the info
my $module2=$module;
$module2=~s/\:\:/\//g;
#fetch the preferences for the module
my %vars=$self->{zconf}->regexVarGet('gui', '^modules/'.quotemeta($module2).'$');
if($self->{zconf}->{error}){
$self->{error}=1;
$self->{errorString}='ZConf error listing sets for the config "gui".'.
' ZConf error="'.$self->{zconf}->{error}.'" '.
'ZConf error string="'.$self->{zconf}->{errorString}.'"';
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
#if we don't get it, try the default
if (!defined($vars{'modules/'.$module2})) {
%vars=$self->{zconf}->regexVarGet('gui', '^default$');
if($self->{zconf}->{error}){
$self->{error}=1;
$self->{errorString}='ZConf error listing sets for the config "gui".'.
' ZConf error="'.$self->{zconf}->{error}.'" '.
'ZConf error string="'.$self->{zconf}->{errorString}.'"';
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
#if the default does not exist
if (!defined($vars{default})) {
$self->{error}=5;
$self->{errorString}='No preferences for "'.$module.'" and there is no default';
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
return split(/:/, $vars{default});
}
return split(/:/, $vars{'modules/'.$module2});
}
sub getSet{
my $self=$_[0];
my $function='getSet';
#blanks any previous errors
$self->errorblank;
if ($self->{error}) {
warn($self->{module}.' '.$function.': A permanent error is set');
return undef;
}
my $set=$self->{zconf}->getSet('gui');
if($self->{zconf}->{error}){
$self->{error}=1;
$self->{errorString}='ZConf error getting the loaded set the config "gui".'.
' ZConf error="'.$self->{zconf}->{error}.'" '.
'ZConf error string="'.$self->{zconf}->{errorString}.'"';
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
return $set;
}
sub getUseX{
my $self=$_[0];
my $module=$_[1];
my $function='getUseX';
$self->errorblank;
if ($self->{error}) {
warn($self->{module}.' '.$function.': A permanent error is set');
return undef;
}
if (!defined($module)) {
$self->{error}=2;
$self->{errorString}='No module specified';
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
#the change it for fetching the info
my $module2=$module;
$module2=~s/\:\:/\//g;
#fetch the preferences for the module
my %vars=$self->{zconf}->regexVarGet('gui', '^useX/'.quotemeta($module2).'$');
if($self->{zconf}->{error}){
$self->{error}=1;
$self->{errorString}='ZConf error listing sets for the config "gui".'.
' ZConf error="'.$self->{zconf}->{error}.'" '.
'ZConf error string="'.$self->{zconf}->{errorString}.'"';
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
#if we don't get it, try the default
if (!defined($vars{'modules/'.$module2})) {
return 1;
}
return $vars{'modules/'.$module2};
}
sub hasPreferred{
my $self=$_[0];
my $module=$_[1];
my $function='hasPreferred';
#blank all previous errors
$self->errorblank;
if ($self->{error}) {
warn($self->{module}.' '.$function.': A permanent error is set');
return undef;
}
if (!defined($module)) {
$self->{error}=2;
$self->{errorString}='No module specified';
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
my %vars=$self->{zconf}->regexVarGet('gui', '^modules/'.quotemeta($module).'$');
if($self->{zconf}->{error}){
$self->{error}=1;
$self->{errorString}='ZConf error listing sets for the config "gui".'.
' ZConf error="'.$self->{zconf}->{error}.'" '.
'ZConf error string="'.$self->{zconf}->{errorString}.'"';
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
if (!defined($vars{'modules/'.$module})) {
return undef;
}
return 1;
}
sub init{
my $self=$_[0];
my $set=$_[1];
my $function='init';
#blanks any previous errors
$self->errorblank;
if ($self->{error}) {
warn($self->{module}.' '.$function.': A permanent error is set');
return undef;
}
my $returned = $self->{zconf}->configExists("gui");
if(defined($self->{zconf}->{error})){
$self->{error}=1;
$self->{errorString}="Could not check if the config 'gui' exists.".
" It failed with '".$self->{zconf}->{error}."', '"
.$self->{zconf}->{errorString}."'";
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
#create the config if it does not exist
if (!$returned) {
$self->{zconf}->createConfig("gui");
if ($self->{zconf}->{error}) {
$self->{error}=1;
$self->{errorString}="Could not create the ZConf config 'gui'.".
" It failed with '".$self->{zconf}->{error}."', '"
.$self->{zconf}->{errorString}."'";
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
}
#create the new set
$self->{zconf}->writeSetFromHash({config=>"gui", set=>$set},
{
default=>"GTK:Curses",
appendOthers=>'1',
}
);
#error if the write failed
if ($self->{zconf}->{error}) {
$self->{error}=1;
$self->{errorString}="writeSetFromHash failed.".
" It failed with '".$self->{zconf}->{error}."', '"
.$self->{zconf}->{errorString}."'";
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
#now that it is initiated, load it
$self->{zconf}->read({config=>'gui', set=>$set});
if ($self->{zconf}->{error}) {
$self->{error}=1;
$self->{errorString}="read failed.".
" It failed with '".$self->{zconf}->{error}."', '"
.$self->{zconf}->{errorString}."'";
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
return 1;
}
sub listAvailable{
my $self=$_[0];
my $module=$_[1];
my $function='listAvailable';
$self->errorblank;
if ($self->{error}) {
warn($self->{module}.' '.$function.': A permanent error is set');
return undef;
}
if (!defined($module)) {
$self->{error}=2;
$self->{errorString}='No module specified';
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
#this is what will be checked for and scrubbed upon return
my $check=$module.'::GUI::';
my $modules=list_modules($check,{ list_modules => 1});
#testing shows this should not happen, but in case it does, handle it
if (!defined($modules)) {
$self->{error}=6;
$self->{errorString}='list_modules failed';
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
my @mods=keys(%{$modules});
my $int=0;
while ($mods[$int]) {
$mods[$int]=~s/^$check//;
$int++;
}
return @mods;
}
sub listModules{
my $self=$_[0];
my $function='listModules';
#blank all previous errors
$self->errorblank;
if ($self->{error}) {
warn($self->{module}.' '.$function.': A permanent error is set');
return undef;
}
my @modules=$self->{zconf}->regexVarSearch('gui', '^modules');
if ($self->{zconf}->{error}) {
$self->{error}=1;
$self->{errorString}="regexVarSearch failed.".
" It failed with '".$self->{zconf}->{error}."', '"
.$self->{zconf}->{errorString}."'";
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
my $int=0;
#removes leading /^modules\//
#also make sure that the ZConf var stuff is replaced with ::
while (defined($modules[$int])) {
$modules[$int]=~s/^modules\///;
$modules[$int]=~s/\//\:\:/g;
$int++;
}
return @modules;
}
sub listSets{
my $self=$_[0];
my $function='listSets';
#blanks any previous errors
$self->errorblank;
if ($self->{error}) {
warn($self->{module}.' '.$function.': A permanent error is set');
return undef;
}
my @sets=$self->{zconf}->getAvailableSets('gui');
if($self->{zconf}->{error}){
$self->{error}=1;
$self->{errorString}='ZConf error listing sets for the config "gui".'.
' ZConf error="'.$self->{zconf}->{error}.'" '.
'ZConf error string="'.$self->{zconf}->{errorString}.'"';
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
return @sets;
}
sub readSet{
my $self=$_[0];
my $set=$_[1];
my $function='readSet';
#blanks any previous errors
$self->errorblank;
if ($self->{error}) {
warn($self->{module}.' '.$function.': A permanent error is set');
return undef;
}
$self->{zconf}->read({config=>'gui', set=>$set});
if ($self->{zconf}->{error}) {
$self->{error}=1;
$self->{errorString}='ZConf error reading the config "gui".'.
' ZConf error="'.$self->{zconf}->{error}.'" '.
'ZConf error string="'.$self->{zconf}->{errorString}.'"';
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
return 1;
}
sub rmPreferred{
my $self=$_[0];
my $module=$_[1];
my $function='rmPreferred';
#blank all previous errors
$self->errorblank;
if ($self->{error}) {
warn($self->{module}.' '.$function.': A permanent error is set');
return undef;
}
if (!defined($module)) {
$self->{errorString}='No module specified';
$self->{error}=2;
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
#remove any specifical characters that have been passed
my $safemodule=quotemeta($module);
my @deleted=$self->{zconf}->regexVarDel('gui', '^modules/'.$safemodule.'$');
if ($self->{zconf}->{error}) {
$self->{error}=1;
$self->{errorString}='ZConf error reading the config "gui".'.
' ZConf error="'.$self->{zconf}->{error}.'" '.
'ZConf error string="'.$self->{zconf}->{errorString}.'"';
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
#only one will be matched so we just need to check the first
if ($deleted[0] ne 'modules/'.$module) {
$self->{errorString}='"'.$module.' not matched"';
$self->{error}=7;
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
return 1;
}
sub setAppendOthers{
my $self=$_[0];
my $boolean=$_[1];
my $function='setAppendOthers';
$self->errorblank;
if ($self->{error}) {
warn($self->{module}.' '.$function.': A permanent error is set');
return undef;
}
#make sure we were passed something
if (!defined($boolean)) {
$self->{error}=8;
$self->{errorString}='No value specified to set "appendOthers" to';
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
#make sure it is a 0 or 1
if ($boolean !~ /^[01]$/) {
$self->{error}=9;
$self->{errorString}='The value "'.$boolean.'" does not match /^[01]$/';
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
#set the value
$self->{zconf}->setVar('gui', 'appendOther');
if($self->{zconf}->{error}){
$self->{error}=1;
$self->{errorString}='ZConf error setting "appendOthers" for "gui".'.
' ZConf error="'.$self->{zconf}->{error}.'" '.
'ZConf error string="'.$self->{zconf}->{errorString}.'"';
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
#update it
$self->{zconf}->writeSetFromLoadedConfig({config=>'gui'});
if($self->{zconf}->{error}){
$self->{error}=1;
$self->{errorString}='ZConf error saving config "gui".'.
' ZConf error="'.$self->{zconf}->{error}.'" '.
'ZConf error string="'.$self->{zconf}->{errorString}.'"';
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
return 1;
}
sub setPreferred{
my $self=$_[0];
my $module=$_[1];
my $prefs;
if (defined($_[2])) {
$prefs=$_[2];
}
my $function='setPreferred';
#blank all previous errors
$self->errorblank;
if ($self->{error}) {
warn($self->{module}.' '.$function.': A permanent error is set');
return undef;
}
if (!defined($module)) {
$self->{error}=2;
$self->{errorString}='No module specified';
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
if (!defined(@{$prefs}[0])) {
$self->{error}=3;
$self->{errorString}='No prefs specified';
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
my $int=0;
while (defined(@{$prefs}[$int])){
if (@{$prefs}[$int] =~ /:/) {
$self->{error}=4;
$self->{errorString}='"'.@{$prefs}[$int].'" matched /:/';
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
$int++;
}
$module=~s/::/\//g;
my $joinedprefs=join(':', @{$prefs});
$self->{zconf}->setVar('gui', 'modules/'.$module, $joinedprefs);
if($self->{zconf}->{error}){
$self->{error}=1;
$self->{errorString}='ZConf error listing sets for the config "gui".'.
' ZConf error="'.$self->{zconf}->{error}.'" '.
'ZConf error string="'.$self->{zconf}->{errorString}.'"';
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
$self->{zconf}->writeSetFromLoadedConfig({config=>'gui'});
if($self->{zconf}->{error}){
$self->{error}=1;
$self->{errorString}='ZConf error saving config "gui".'.
' ZConf error="'.$self->{zconf}->{error}.'" '.
'ZConf error string="'.$self->{zconf}->{errorString}.'"';
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
return 1;
}
sub setUseX{
my $self=$_[0];
my $module=$_[1];
my $useX=$_[2];
my $function='setUseX';
$self->errorblank;
if ($self->{error}) {
warn($self->{module}.' '.$function.': A permanent error is set');
return undef;
}
if (!defined($module)) {
$self->{error}=2;
$self->{errorString}='No module specified';
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
if (!defined($useX)) {
$self->{error}=3;
$self->{errorString}='No prefs specified';
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
$module=~s/::/\//g;
$self->{zconf}->setVar('gui', 'useX/'.$module, $useX);
if($self->{zconf}->{error}){
$self->{error}=1;
$self->{errorString}='ZConf error listing sets for the config "gui".'.
' ZConf error="'.$self->{zconf}->{error}.'" '.
'ZConf error string="'.$self->{zconf}->{errorString}.'"';
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
$self->{zconf}->writeSetFromLoadedConfig({config=>'gui'});
return 1;
}
sub termAvailable{
my $self=$_[0];
my $function='termAvailable';
$self->errorblank;
if ($self->{error}) {
warn($self->{module}.' '.$function.': A permanent error is set');
return undef;
}
if (!defined($ENV{TERM})) {
return undef;
}
return 1;
}
sub Xavailable{
my $self=$_[0];
my $function='Xavailable';
$self->errorblank;
if ($self->{error}) {
warn($self->{module}.' '.$function.': A permanent error is set');
return undef;
}
#if this is defined, the next one definitely will not work
if (!defined($ENV{DISPLAY})) {
return undef;
}
#exists non-zero if it fails
my $command='/bin/sh -c \'xhost 2> /dev/null > /dev/null\'';
system($command);
#if xhost exits with a non-zero then X is not available
my $exitcode=$? >> 8;
if ($exitcode ne '0'){
return undef;
}
return 1;
}
sub useX{
my $self=$_[0];
my $module=$_[1];
my $function='useX';
$self->errorblank;
if ($self->{error}) {
warn($self->{module}.' '.$function.': A permanent error is set');
return undef;
}
if (!defined($module)) {
$self->{error}=2;
$self->{errorString}='No module specified';
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
#get if X should be used
my $useX=$self->getUseX($module);
#if it should be used, make sure it is available
if ($useX) {
return $self->Xavailable;
}
return undef;
}
sub which{
my $self=$_[0];
my $module=$_[1];
my $function='which';
#blank all previous errors
$self->errorblank;
if ($self->{error}) {
warn($self->{module}.' '.$function.': A permanent error is set');
return undef;
}
if (!defined($module)) {
$self->{error}=2;
$self->{errorString}='No module specified';
warn($self->{module}.' '.$function.':'.$self->{error}.': '.$self->{errorString});
return undef;
}
my @prefs=$self->getPreferred($module);
#checks if X and/or a terminal is available
my $Xavailable=$self->Xavailable();
my $termAvailable=$self->termAvailable();
#gets usable modules
my @available=$self->listAvailable($module);
#this will be returned
my @usable;
#get the preferred ones
my @preferred=$self->getPreferred($module);
#builds the list out of the prefered modules initially
my $int=0;
while (defined($preferred[$int])) {
my $aint=0;
my $matched=0;
while ((defined($available[$aint])) && (!$matched)) {
if ($preferred[$int] eq $available[$aint]) {
if ($Xavailable) {
push(@usable, $preferred[$int]);
$matched=1;
}else {
if ($preferred[$int]=~/^Term/) {
push(@usable, $preferred[$int]);
}
if ($preferred[$int]=~/^Curses/) {
push(@usable, $preferred[$int]);
}
$matched=1;
}
$aint++;
}
$aint++;
}
$int++;
}
#determine if we should append others or not
my $ao=$self->getAppendOthers;
if ($self->{error}) {
warn('ZConf-GUI which: getAppendOthers errored');
return undef;
}
#only process AO if we need to
if (!$ao) {
return @usable;
}
#append others if we need to
$int=0;
while (defined($available[$int])) {
#make sure it has not been added previously
my $matched=0;
my $int2=0;
while ($usable[$int2]) {
if ($usable[$int2] eq $available[$int]) {
$matched=1;
}
$int2++;
}
#if it is not matched, added it
if (!$matched) {
push(@usable, $available[$int]);
}
$int++;
}
return @usable;
}
#blanks the error flags
sub errorblank{
my $self=$_[0];
if ($self->{perror}) {
return undef;
}
$self->{error}=undef;
$self->{errorString}="";
return 1;
}
1; # End of ZConf::GUI