src/external/3rd/library/perforce/include/clientuser.h

   1 /*
   2  * Copyright 1995, 2000 Perforce Software.  All rights reserved.
   3  *
   4  * This file is part of Perforce - the FAST SCM System.
   5  */
   6
   7 /*
   8  * ClientUser - user interface primitives
   9  *
  10  * Public classes:
  11  *
  12  *      ClientUser - user interface for client services
  13  *
  14  * Note that not all methods are always used.  Here's a guideline:
  15  *
  16  *      Used by almost all Perforce commands:
  17  *
  18  *              Finished
  19  *              HandleError
  20  *              OutputBinary
  21  *              OutputError
  22  *              OutputInfo
  23  *              OutputText
  24  *              File
  25  *
  26  *      Used only by commands that read the client's stdin:
  27  *
  28  *              InputData
  29  *
  30  *      Used only by 'p4 fstat' and some other commands when the
  31  *      protocol variable 'tag' is set:
  32  *
  33  *              OutputStat
  34  *
  35  *      Used only by interactive commands that can generally be avoided:
  36  *
  37  *              Diff
  38  *              Edit
  39  *              ErrorPause
  40  *              Prompt
  41  *
  42  *      Used only by the default ClientUser implementation:
  43  *
  44  *              Help
  45  *              Merge
  46  *
  47  * Public methods:
  48  *
  49  *      ClientUser::InputData() - provide data to 'p4 spec-command -i';
  50  *              spec-command is branch, change, client, job, label, protect,
  51  *              user, etc.
  52  *
  53  *      ClientUser::HandleError() - process error data, the result of a failed
  54  *              command.  Default is to format output and call OutputError().
  55  *
  56  *      ClientUser::Message() - output error or tabular data.  This is the
  57  *              2002.1 replacement for OutputInfo/Error: earlier servers
  58  *              will invoke still HandleError() and OutputInfo().
  59  *
  60  *      ClinetUser::OutputError() - output error data, the result of a failed
  61  *              command.
  62  *
  63  *      ClientUser::OutputInfo() - output tabular data, the result of most
  64  *              commands that report metadata.
  65  *
  66  *      ClientUser::OutputBinary() - output binary data, generally the result
  67  *              of 'p4 print binary_file'.
  68  *
  69  *      ClientUser::OutputText() - output text data, generally the result
  70  *              of 'p4 print text_file'.
  71  *
  72  *      ClientUser::OutputStat() - output results of 'p4 fstat'; requires
  73  *              calling StrDict::GetVar() to get the actual variable results.
  74  *
  75  *      ClientUser::Prompt() - prompt the user, and wait for a response.
  76  *
  77  *      ClientUser::ErrorPause() - print an error message and wait for the
  78  *              user before continuing.
  79  *
  80  *      ClientUser::Edit() - bring the user's editor up on a file; generally
  81  *              part of 'p4 spec-command'.
  82  *
  83  *      ClientUser::Diff() - diff two files, and display the results; the
  84  *              result of 'p4 diff'.
  85  *
  86  *      ClientUser::Merge() - merge three files and save the results; the
  87  *              result of saying 'm' to the resolve dialog of 'p4 resolve'.
  88  *
  89  *      ClientUser::Help() - dump out a block of help text to the user;
  90  *              used by the resolve dialogs.
  91  *
  92  *      ClientUser::File() - produce a FileSys object for reading
  93  *              and writing files in client workspace.
  94  *
  95  *      ClientUser::Finished() - called when tagged client call is finished.
  96  */
  97
  98 class Enviro;
  99 class ClientMerge;
 100
 101 class ClientUser {
 102
 103     public:
 104                         ClientUser() { binaryStdout = 0; }
 105         virtual         ~ClientUser();
 106
 107         virtual void    InputData( StrBuf *strbuf, Error *e );
 108
 109         virtual void    HandleError( Error *err );
 110         virtual void    Message( Error *err );
 111         virtual void    OutputError( const_char *errBuf );
 112         virtual void    OutputInfo( char level, const_char *data );
 113         virtual void    OutputBinary( const_char *data, int length );
 114         virtual void    OutputText( const_char *data, int length );
 115
 116         virtual void    OutputStat( StrDict *varList );
 117
 118         virtual void    Prompt( const StrPtr &msg, StrBuf &rsp,
 119                                 int noEcho, Error *e );
 120         virtual void    ErrorPause( char *errBuf, Error *e );
 121
 122         virtual void    Edit( FileSys *f1, Error *e );
 123
 124         virtual void    Diff( FileSys *f1, FileSys *f2, int doPage,
 125                                 char *diffFlags, Error *e );
 126
 127         virtual void    Merge( FileSys *base, FileSys *leg1, FileSys *leg2,
 128                                 FileSys *result, Error *e );
 129
 130         virtual int     Resolve( ClientMerge *m, Error *e );
 131
 132         virtual void    Help( const_char *const *help );
 133
 134         virtual FileSys *File( FileSysType type );
 135
 136         virtual void    Finished() {}
 137
 138         StrDict         *varList;       // (cheesy) access to RPC buffer
 139         Enviro          *enviro;        // (cheesy) access to Client's env
 140
 141         static void     Edit( FileSys *f1, Enviro * env, Error *e );
 142
 143         static void     RunCmd( const char *command, const char *arg1,
 144                                 const char *arg2, const char *arg3,
 145                                 const char *arg4, const char *pager,
 146                                 Error *e );
 147
 148     private:
 149         int             binaryStdout;   // stdout is in binary mode
 150 } ;
 151
 152 /*
 153  * StrDict now provides the GetVar() interface for OutputStat();
 154  * ClientVarList defined for backward compatability.
 155  */
 156
 157 typedef StrDict ClientVarList;