summaryrefslogtreecommitdiffstats
path: root/libtdepim/tdeconfigpropagator.h
blob: cc9381a5858d058457b24ef37d58084a5ea9c55e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
/*
    This file is part of libtdepim.

    Copyright (c) 2003 Cornelius Schumacher <schumacher@kde.org>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/
#ifndef TDECONFIGPROPAGATOR_H
#define TDECONFIGPROPAGATOR_H

#include <tqstring.h>
#include <tqvaluelist.h>
#include <tqdom.h>
#include <tqptrlist.h>

#include <tdemacros.h>

class TDEConfigSkeleton;
class TDEConfigSkeletonItem;

class TDE_EXPORT TDEConfigPropagator
{
  public:

    /**
      Create TDEConfigPropagator object without associated source configuration.
    */
    TDEConfigPropagator();
    /**
      Create TDEConfigPropagator object.
      
      @param skeleton TDEConfigSkeleton object used as source for the propagation
      @param kcfgFile file name of kcfg file containing the propagation rules
    */
    TDEConfigPropagator( TDEConfigSkeleton *skeleton, const TQString &kcfgFile );
    virtual ~TDEConfigPropagator() {}

    TDEConfigSkeleton *skeleton() { return mSkeleton; }

    /*
      Commit changes according to propagation rules.
    */
    void commit();

    class TDE_EXPORT Condition
    {
      public:
        Condition() : isValid( false ) {}
      
        TQString file;
        TQString group;
        TQString key;
        TQString value;
        
        bool isValid;
    };

    class TDE_EXPORT Rule
    {
      public:
        typedef TQValueList<Rule> List;
        
        Rule() : hideValue( false ) {}
        
        TQString sourceFile;
        TQString sourceGroup;
        TQString sourceEntry;

        TQString targetFile;
        TQString targetGroup;
        TQString targetEntry;

        Condition condition;

        bool hideValue;
    };

    class TDE_EXPORT Change
    {
      public:
        typedef TQPtrList<Change> List;

        Change( const TQString &title ) : mTitle( title ) {}
        virtual ~Change();
      
        void setTitle( const TQString &title ) { mTitle = title; }
        TQString title() const { return mTitle; }

        virtual TQString arg1() const { return TQString(); }
        virtual TQString arg2() const { return TQString(); }

        virtual void apply() = 0;

      private:
        TQString mTitle;
    };

    class TDE_EXPORT ChangeConfig : public Change
    {
      public:
        ChangeConfig();
        ~ChangeConfig() {}

        TQString arg1() const;
        TQString arg2() const;

        void apply();

        TQString file;
        TQString group;
        TQString name;
        TQString label;
        TQString value;
        bool hideValue;
    };

    void updateChanges();
    
    Change::List changes();

    Rule::List rules();

  protected:
    void init();

    /**
      Implement this function in a subclass if you want to add changes which
      can't be expressed as propagations in the kcfg file.
    */
    virtual void addCustomChanges( Change::List & ) {}

    TDEConfigSkeletonItem *findItem( const TQString &group, const TQString &name );

    TQString itemValueAsString( TDEConfigSkeletonItem * );

    void readKcfgFile();

    Rule parsePropagation( const TQDomElement &e );
    Condition parseCondition( const TQDomElement &e );

    void parseConfigEntryPath( const TQString &path, TQString &file,
                               TQString &group, TQString &entry );

  private:
    TDEConfigSkeleton *mSkeleton;
    TQString mKcfgFile;

    Rule::List mRules;
    Change::List mChanges;    
};

#endif