@ -31,6 +31,8 @@
# include <tqvaluelist.h> # include <tqvaluelist.h>
# include <tqstringlist.h> # include <tqstringlist.h>
class KateViewSpace ;
class OldKateSessionManager ; // Michele - to be removed with OldKateSession
class OldKateSessionManager ; // Michele - to be removed with OldKateSession
class KDirWatch ; class KDirWatch ;
@ -41,68 +43,76 @@ class TQCheckBox;
class KateSession class KateSession
{ {
public : public :
/**
/**
* create a new session and read the config from fileName if it exists * create a new session and read the config from fileName if it exists
* @ param sessionName session name * @ param sessionName session name
* @ param fileName file where session config is saved to / restored from * @ param fileName file where session config is saved to / restored from
* @ param isFullName true - > filename is a full filename , used to load / save the session configuration * @ param isFullName true - > filename is a full filename , used to load / save the session configuration
* false - > filename is a folder name . This is used for new unsaved sessions * false - > filename is a folder name . This is used for new unsaved sessions
* to inject the location where the configuration file should be saved * to inject the location where the configuration file should be saved
*/ */
KateSession ( const TQString & sessionName , const TQString & fileName , bool isFullName ) ; KateSession ( const TQString & sessionName , const TQString & fileName , bool isFullName ) ;
/**
/**
* Destructor * Destructor
*/ */
~ KateSession ( ) ;
~ KateSession ( ) ;
/**
/**
* @ return the session name * @ return the session name
*/ */
const TQString & getSessionName ( ) const { return m_sessionName ; }
const TQString & getSessionName ( ) const { return m_sessionName ; }
/**
/**
* Set the new session name * Set the new session name
* @ param sessionName the new session name * @ param sessionName the new session name
*/ */
void setSessionName ( const TQString & sessionName ) ;
void setSessionName ( const TQString & sessionName ) ;
/**
/**
* @ return whether the session is read only or not * @ return whether the session is read only or not
*/ */
bool isReadOnly ( ) const { return m_readOnly ; }
bool isReadOnly ( ) const { return m_readOnly ; }
/**
/**
* Set session read only status * Set session read only status
* @ param readOnly if true , the session config can not be saved to file * @ param readOnly if true , the session config can not be saved to file
*/ */
void setReadOnly ( bool readOnly ) ;
void setReadOnly ( bool readOnly ) ;
/**
/**
* @ return the session filename * @ return the session filename
*/ */
const TQString & getSessionFilename ( ) const { return m_filename ; }
const TQString & getSessionFilename ( ) const { return m_filename ; }
/**
/**
* Save session info * Save session info
* @ param saveDocList if true , save also the information about the documents currently open * @ param saveGUIInfo if true , save also the information about the GUI elements
*/ */
void save ( bool saveDocList ) ;
void save ( bool saveGUIInfo ) ;
/**
/**
* Activate the session
* Activate the session
*/
*/
void activate ( ) ;
void activate ( ) ;
private :
private :
TQString m_sessionName ;
TQString m_filename ;
friend class KateViewSpace ;
bool m_isFullName ; // true -> m_filename is a full filename
/**
// false -> m_filename is a folder name.
* @ return the session config object
bool m_readOnly ;
*/
int m_docCount ; // number of documents in the session
TDEConfig * getConfig ( ) { return m_config ; }
TQStringList m_documents ; // document URLs
KSimpleConfig * m_config ; // session config
TQString m_sessionName ;
TQString m_filename ;
bool m_isFullName ; // true -> m_filename is a full filename
// false -> m_filename is a folder name.
bool m_readOnly ;
int m_docCount ; // number of documents in the session
TQStringList m_documents ; // document URLs
KSimpleConfig * m_config ; // session config
} ; } ;
@ -110,56 +120,88 @@ class KateSession
//------------------------------------
//------------------------------------
class KateSessionManager class KateSessionManager
{ {
public : public :
/**
enum
* get a pointer to the unique KateSessionManager instance .
{
* If the manager does not exist yet , create it .
INVALID_SESSION = - 1
*/
} ;
static KateSessionManager * self ( ) ;
/**
/**
* Destructor
* get a pointer to the unique KateSessionManager instance .
*/
* If the manager does not exist yet , create it .
~ KateSessionManager ( ) ;
*/
static KateSessionManager * self ( ) ;
/**
/**
* Save session manager info * Destructor
*/ */
void saveConfig ( ) ;
~ KateSessionManager ( ) ;
/**
/**
* @ return the active session id * Save session manager info
*/ */
int getActiveSessionId ( ) const { return m_activeSessionId ; }
void saveConfig ( ) ;
/**
/**
* @ return a reference to the active session
* @ return the active session id
*/
*/
KateSession * getActiveSession ( ) { return m_sessions [ m_activeSessionId ] ; }
int getActiveSessionId ( ) const { return m_activeSessionId ; }
/**
* @ return the active session name
*/
const TQString & getActiveSessionName ( ) /*FIXME const*/ { return m_sessions [ m_activeSessionId ] - > getSessionName ( ) ; }
/**
* @ return a reference to the active session
*/
KateSession * getActiveSession ( ) { return m_sessions [ m_activeSessionId ] ; }
/**
* @ return a reference to the sessions list
*/
TQPtrList < KateSession > & getSessionsList ( ) { return m_sessions ; }
/**
/**
* @ return a reference to the sessions list
* Returns the session id of the first session whose name matches the
* provided one
* @ param name the session name to look for
* @ return the session id of the matching session if it is found ,
* otherwise KateSessionManager : : INVALID_SESSION .
*/
*/
TQPtrList < KateSession > & getSessionsList ( ) { return m_sessions ; }
int getSessionIdFromName ( const TQString & name ) ;
/**
* Activates the selected session .
* @ param sessionId the id of the session to activate
* @ param saveCurr if true , save the current session before activating the new one
* @ return whether the session was activated or not
*/
bool activateSession ( int sessionId , bool saveCurr = true ) ;
/**
/**
* Activates the selected session .
* Restore the last saved session . Can only be used before
* @ param sessionId the id of the session to activate
* any other session has been activated , i . e . on Kate ' s startup
* @ param saveCurr if true , save the current session before activating the new one
* @ return whether the session was activated or not
* @ return whether the session was activated or not
*/
*/
bool activateSession ( int sessionId , bool saveCurr = true ) ;
bool restoreLastSession( ) ;
private :
/**
KateSessionManager ( ) ;
* Saves the active session
*/
void saveActiveSession ( ) { m_sessions [ m_activeSessionId ] - > save ( true ) ; }
private :
KateSessionManager ( ) ;
TQString m_baseDir ; // folder where session files are stored
TQString m_baseDir ; // folder where session files are stored
TQString m_configFile ; // file where the session list config is stored
TQString m_configFile ; // file where the session list config is stored
int m_sessionsCount ; // number of sessions
int m_sessionsCount ; // number of sessions
int m_activeSessionId ; // index of the active session
int m_activeSessionId ; // index of the active session
TQPtrList < KateSession > m_sessions ; // session list
bool m_firstActivation ; // true until at least one session has been activated
KSimpleConfig * m_config ; // session manager config
TQPtrList < KateSession > m_sessions ; // session list
KSimpleConfig * m_config ; // session manager config
static KateSessionManager * ksm_instance ; // the only KateSessionManager instance
static KateSessionManager * ksm_instance ; // the only KateSessionManager instance
} ; } ;
@ -173,380 +215,382 @@ class KateSessionManager
//------------------------------------
//------------------------------------
class OldKateSession : public TDEShared class OldKateSession : public TDEShared
{ {
public : public :
/**
/**
* Define a Shared - Pointer type * Define a Shared - Pointer type
*/ */
typedef TDESharedPtr < OldKateSession > Ptr ; typedef TDESharedPtr < OldKateSession > Ptr ;
public : public :
/**
/**
* create a session from given file * create a session from given file
* @ param fileName session filename , relative * @ param fileName session filename , relative
* @ param name session name * @ param name session name
* @ param manager pointer to the manager * @ param manager pointer to the manager
*/ */
OldKateSession ( OldKateSessionManager * manager , const TQString & fileName , const TQString & name ) ; OldKateSession ( OldKateSessionManager * manager , const TQString & fileName , const TQString & name ) ;
/**
/**
* init the session object , after construction or create * init the session object , after construction or create
*/ */
void init ( ) ; void init ( ) ;
/**
/**
* destruct me * destruct me
*/ */
~ OldKateSession ( ) ; ~ OldKateSession ( ) ;
/**
/**
* session filename , absolute , calculated out of relative filename + session dir * session filename , absolute , calculated out of relative filename + session dir
* @ return absolute path to session file * @ return absolute path to session file
*/ */
TQString sessionFile ( ) const ; TQString sessionFile ( ) const ;
/**
/**
* relative session filename * relative session filename
* @ return relative filename for this session * @ return relative filename for this session
*/ */
const TQString & sessionFileRelative ( ) const { return m_sessionFileRel ; } const TQString & sessionFileRelative ( ) const { return m_sessionFileRel ; }
/**
/**
* session name * session name
* @ return name for this session * @ return name for this session
*/ */
const TQString & sessionName ( ) const { return m_sessionName ; } const TQString & sessionName ( ) const { return m_sessionName ; }
/**
/**
* is this a valid session ? if not , don ' t use any session if this is * is this a valid session ? if not , don ' t use any session if this is
* the active one * the active one
*/ */
bool isNew ( ) const { return m_sessionName . isEmpty ( ) ; } bool isNew ( ) const { return m_sessionName . isEmpty ( ) ; }
/**
/**
* create the session file , if not existing * create the session file , if not existing
* @ param name name for this session * @ param name name for this session
* @ param force force to create new file * @ param force force to create new file
* @ return true if created , false if no creation needed * @ return true if created , false if no creation needed
*/ */
bool create ( const TQString & name , bool force = false ) ; bool create ( const TQString & name , bool force = false ) ;
/**
/**
* rename this session * rename this session
* @ param name new name * @ param name new name
* @ return success * @ return success
*/ */
bool rename ( const TQString & name ) ; bool rename ( const TQString & name ) ;
/**
/**
* config to read * config to read
* on first access , will create the config object , delete will be done automagic * on first access , will create the config object , delete will be done automagic
* return 0 if we have no file to read config from atm * return 0 if we have no file to read config from atm
* @ return config to read from * @ return config to read from
*/ */
TDEConfig * configRead ( ) ; TDEConfig * configRead ( ) ;
/**
/**
* config to write * config to write
* on first access , will create the config object , delete will be done automagic * on first access , will create the config object , delete will be done automagic
* return 0 if we have no file to write config to atm * return 0 if we have no file to write config to atm
* @ return config to write from * @ return config to write from
*/ */
TDEConfig * configWrite ( ) ; TDEConfig * configWrite ( ) ;
/**
/**
* count of documents in this session * count of documents in this session
* @ return documents count * @ return documents count
*/ */
unsigned int documents ( ) const { return m_documents ; } unsigned int documents ( ) const { return m_documents ; }
private : private :
/**
/**
* session filename , in local location we can write to * session filename , in local location we can write to
* relative filename to the session dirs : ) * relative filename to the session dirs : )
*/ */
TQString m_sessionFileRel ; TQString m_sessionFileRel ;
/**
/**
* session name , extracted from the file , to display to the user * session name , extracted from the file , to display to the user
*/ */
TQString m_sessionName ; TQString m_sessionName ;
/**
/**
* number of document of this session * number of document of this session
*/ */
unsigned int m_documents ; unsigned int m_documents ;
/**
/**
* OldKateSessionMananger * OldKateSessionMananger
*/ */
OldKateSessionManager * m_manager ; OldKateSessionManager * m_manager ;
/**
/**
* simpleconfig to read from * simpleconfig to read from
*/ */
KSimpleConfig * m_readConfig ; KSimpleConfig * m_readConfig ;
/**
/**
* simpleconfig to write to * simpleconfig to write to
*/ */
KSimpleConfig * m_writeConfig ; KSimpleConfig * m_writeConfig ;
} ; } ;
typedef TQValueList < OldKateSession : : Ptr > OldKateSessionList ; typedef TQValueList < OldKateSession : : Ptr > OldKateSessionList ;
class OldKateSessionManager : public TQObject class OldKateSessionManager : public TQObject
{ {
Q_OBJECT Q_OBJECT
public : public :
OldKateSessionManager ( TQObject * parent ) ; OldKateSessionManager ( TQObject * parent ) ;
~ OldKateSessionManager ( ) ; ~ OldKateSessionManager ( ) ;
/**
/**
* allow access to this : ) * allow access to this : )
* @ return instance of the session manager * @ return instance of the session manager
*/ */
static OldKateSessionManager * self ( ) ; static OldKateSessionManager * self ( ) ;
/**
/**
* allow access to the session list * allow access to the session list
* kept up to date by watching the dir * kept up to date by watching the dir
*/ */
inline OldKateSessionList & sessionList ( ) { updateSessionList ( ) ; return m_sessionList ; } inline OldKateSessionList & sessionList ( ) { updateSessionList ( ) ; return m_sessionList ; }
/**
/**
* activate a session * activate a session
* first , it will look if a session with this name exists in list * first , it will look if a session with this name exists in list
* if yes , it will use this session , else it will create a new session file * if yes , it will use this session , else it will create a new session file
* @ param session session to activate * @ param session session to activate
* @ param closeLast try to close last session or not ? * @ param closeLast try to close last session or not ?
* @ param saveLast try to save last session or not ? * @ param saveLast try to save last session or not ?
* @ param loadNew load new session stuff ? * @ param loadNew load new session stuff ?
*/ */
void activateSession ( OldKateSession : : Ptr session , bool closeLast = true , bool saveLast = true , bool loadNew = true ) ; void activateSession ( OldKateSession : : Ptr session , bool closeLast = true , bool saveLast = true , bool loadNew = true ) ;
/**
/**
* create a new session * create a new session
* @ param name session name * @ param name session name
*/ */
OldKateSession : : Ptr createSession ( const TQString & name ) ; OldKateSession : : Ptr createSession ( const TQString & name ) ;
/**
/**
* return session with given name * return session with given name
* if no existing session matches , create new one with this name * if no existing session matches , create new one with this name
* @ param name session name * @ param name session name
*/ */
OldKateSession : : Ptr giveSession ( const TQString & name ) ; OldKateSession : : Ptr giveSession ( const TQString & name ) ;
/**
/**
* save current session * save current session
* for sessions without filename : save nothing * for sessions without filename : save nothing
* @ param tryAsk should we ask user if needed ? * @ param tryAsk should we ask user if needed ?
* @ param rememberAsLast remember this session as last used ? * @ param rememberAsLast remember this session as last used ?
* @ return success * @ return success
*/ */
bool saveActiveSession ( bool tryAsk = false , bool rememberAsLast = false ) ; bool saveActiveSession ( bool tryAsk = false , bool rememberAsLast = false ) ;
/**
/**
* return the current active session * return the current active session
* sessionFile = = empty means we have no session around for this instance of kate * sessionFile = = empty means we have no session around for this instance of kate
* @ return session active atm * @ return session active atm
*/ */
inline OldKateSession : : Ptr activeSession ( ) { return m_activeSession ; } inline OldKateSession : : Ptr activeSession ( ) { return m_activeSession ; }
/**
/**
* session dir * session dir
* @ return global session dir * @ return global session dir
*/ */
inline const TQString & sessionsDir ( ) const { return m_sessionsDir ; } inline const TQString & sessionsDir ( ) const { return m_sessionsDir ; }
/**
/**
* initial session chooser , on app start * initial session chooser , on app start
* @ return success , if false , app should exit * @ return success , if false , app should exit
*/ */
bool chooseSession ( ) ; bool chooseSession ( ) ;
public slots : public slots :
/**
/**
* try to start a new session * try to start a new session
* asks user first for name * asks user first for name
*/ */
void sessionNew ( ) ; void sessionNew ( ) ;
/**
/**
* try to open a existing session * try to open a existing session
*/ */
void sessionOpen ( ) ; void sessionOpen ( ) ;
/**
/**
* try to save current session * try to save current session
*/ */
void sessionSave ( ) ; void sessionSave ( ) ;
/**
/**
* try to save as current session * try to save as current session
*/ */
void sessionSaveAs ( ) ; void sessionSaveAs ( ) ;
/**
/**
* show dialog to manage our sessions * show dialog to manage our sessions
*/ */
void sessionManage ( ) ; void sessionManage ( ) ;
private slots : private slots :
void dirty ( const TQString & path ) ; void dirty ( const TQString & path ) ;
public : public :
/**
/**
* trigger update of session list * trigger update of session list
*/ */
void updateSessionList ( ) ; void updateSessionList ( ) ;
private : private :
/**
/**
* absolute path to dir in home dir where to store the sessions * absolute path to dir in home dir where to store the sessions
*/ */
TQString m_sessionsDir ; TQString m_sessionsDir ;
/**
/**
* list of current available sessions * list of current available sessions
*/ */
OldKateSessionList m_sessionList ; OldKateSessionList m_sessionList ;
/**
/**
* current active session * current active session
*/ */
OldKateSession : : Ptr m_activeSession ; OldKateSession : : Ptr m_activeSession ;
} ; } ;
class OldKateSessionChooser : public KDialogBase class OldKateSessionChooser : public KDialogBase
{ {
Q_OBJECT Q_OBJECT
public : public :
OldKateSessionChooser ( TQWidget * parent , const TQString & lastSession ) ; OldKateSessionChooser ( TQWidget * parent , const TQString & lastSession ) ;
~ OldKateSessionChooser ( ) ; ~ OldKateSessionChooser ( ) ;
OldKateSession : : Ptr selectedSession ( ) ; OldKateSession : : Ptr selectedSession ( ) ;
bool reopenLastSession ( ) ; bool reopenLastSession ( ) ;
enum {
enum
resultQuit = TQDialog : : Rejected ,
{
resultOpen ,
resultQuit = TQDialog : : Rejected ,
resultNew ,
resultOpen ,
resultNone
resultNew ,
} ;
resultNone
} ;
protected slots : protected slots :
/**
/**
* open session * open session
*/ */
void slotUser1 ( ) ; void slotUser1 ( ) ;
/**
/**
* new session * new session
*/ */
void slotUser2 ( ) ; void slotUser2 ( ) ;
/**
/**
* quit kate * quit kate
*/ */
void slotUser3 ( ) ; void slotUser3 ( ) ;
/**
/**
* selection has changed * selection has changed
*/ */
void selectionChanged ( ) ; void selectionChanged ( ) ;
private : private :
TDEListView * m_sessions ; TDEListView * m_sessions ;
TQCheckBox * m_useLast ; TQCheckBox * m_useLast ;
} ; } ;
class OldKateSessionOpenDialog : public KDialogBase class OldKateSessionOpenDialog : public KDialogBase
{ {
Q_OBJECT Q_OBJECT
public : public :
OldKateSessionOpenDialog ( TQWidget * parent ) ; OldKateSessionOpenDialog ( TQWidget * parent ) ;
~ OldKateSessionOpenDialog ( ) ; ~ OldKateSessionOpenDialog ( ) ;
OldKateSession : : Ptr selectedSession ( ) ; OldKateSession : : Ptr selectedSession ( ) ;
enum {
enum
resultOk ,
{
resultCancel
resultOk ,
} ;
resultCancel
} ;
protected slots : protected slots :
/**
/**
* cancel pressed * cancel pressed
*/ */
void slotUser1 ( ) ; void slotUser1 ( ) ;
/**
/**
* ok pressed * ok pressed
*/ */
void slotUser2 ( ) ; void slotUser2 ( ) ;
private : private :
TDEListView * m_sessions ; TDEListView * m_sessions ;
} ; } ;
class OldKateSessionManageDialog : public KDialogBase class OldKateSessionManageDialog : public KDialogBase
{ {
Q_OBJECT
Q_OBJECT
public :
OldKateSessionManageDialog ( TQWidget * parent ) ;
~ OldKateSessionManageDialog ( ) ;
protected slots :
public :
/**
OldKateSessionManageDialog ( TQWidget * parent ) ;
* close pressed
~ OldKateSessionManageDialog ( ) ;
*/
void slotUser1 ( ) ;
/**
protected slots :
* selection has changed
/**
*/
* close pressed
void selectionChanged ( ) ;
*/
void slotUser1 ( ) ;
/**
/**
* try to rename session * selection has changed
*/ */
void rename ( ) ; void selectionChanged ( ) ;
/**
/**
* try to delet e session * try to renam e session
*/ */
void del ( ) ; void rename ( ) ;
private :
/**
/**
* try to delete session
* update our list
*/
*/
void del ( ) ;
void updateSessionList ( ) ;
private :
private :
TDEListView * m_sessions ;
/**
KPushButton * m_rename ;
* update our list
KPushButton * m_del ;
*/
void updateSessionList ( ) ;
private :
TDEListView * m_sessions ;
KPushButton * m_rename ;
KPushButton * m_del ;
} ; } ;
class OldKateSessionsAction : public TDEActionMenu class OldKateSessionsAction : public TDEActionMenu
{ {
Q_OBJECT
Q_OBJECT
public : public :
OldKateSessionsAction ( const TQString & text , TQObject * parent = 0 , const char * name = 0 ) ; OldKateSessionsAction ( const TQString & text , TQObject * parent = 0 , const char * name = 0 ) ;
~ OldKateSessionsAction ( ) { ; } ; ~ OldKateSessionsAction ( ) { ; } ;
public slots : public slots :
void slotAboutToShow ( ) ; void slotAboutToShow ( ) ;
void openSession ( int i ) ; void openSession ( int i ) ;
} ; } ;
# endif # endif
