p4goclientuser.h

/*******************************************************************************

Copyright (c) 2024, Perforce Software, Inc.  All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1.  Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.

2.  Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL PERFORCE SOFTWARE, INC. BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*******************************************************************************/

class P4GoSpecMgr;
class ClientProgress;

typedef void ( *cbInit_t )( void*, int );
typedef void ( *cbDesc_t )( void*, char*, int );
typedef void ( *cbTotal_t )( void*, long );
typedef void ( *cbUpdate_t )( void*, long );
typedef void ( *cbDone_t )( void*, int );

typedef int ( *cbHandleBin_t )( void*, char*, int );
typedef int ( *cbHandleMsg_t )( void*, Error* e );
typedef int ( *cbHandleStat_t )( void*, StrDict* d );
typedef int ( *cbHandleText_t )( void*, char* );
typedef int ( *cbHandleTrack_t )( void*, char* );
typedef int ( *cbHandleSpec_t )( void*, P4GoSpecData* );

class P4GoProgress
{
  public:
    P4GoProgress( cbInit_t cbInit,
                  cbDesc_t cbDesc,
                  cbTotal_t cbTotal,
                  cbUpdate_t cbUpdate,
                  cbDone_t cbDone );
    void Init( int type );
    void Description( const StrPtr* d, int u );
    void Total( long t );
    void Update( long update );
    void Done( int f );

  private:
    cbInit_t cbInit;
    cbDesc_t cbDesc;
    cbTotal_t cbTotal;
    cbUpdate_t cbUpdate;
    cbDone_t cbDone;
};

class P4GoHandler
{
  public:
    P4GoHandler( cbHandleBin_t cbHandleBin,
                 cbHandleMsg_t cbHandleMsg,
                 cbHandleStat_t cbHandleStat,
                 cbHandleText_t cbHandleText,
                 cbHandleTrack_t cbHandleTrack,
                 cbHandleSpec_t cbHandleSpec );
    int HandleBinary( StrPtr data );
    int HandleMessage( Error* e );
    int HandleStat( StrDict* d );
    int HandleText( StrPtr data );
    int HandleTrack( StrPtr data );
    int HandleSpec( P4GoSpecData* spec );

  private:
    cbHandleBin_t cbHandleBin;
    cbHandleMsg_t cbHandleMsg;
    cbHandleStat_t cbHandleStat;
    cbHandleText_t cbHandleText;
    cbHandleTrack_t cbHandleTrack;
    cbHandleSpec_t cbHandleSpec;
};

typedef int ( *cbSSOAuthorize_t )( void*, StrDict* d, int l, char** result );

class P4GoSSOHandler : public ClientSSO
{
  public:
    P4GoSSOHandler( cbSSOAuthorize_t cbSSOAuthorize );
    ClientSSOStatus Authorize( StrDict& vars, int maxLength, StrBuf& result );

  private:
    cbSSOAuthorize_t cbSSOAuthorize;
};

typedef int ( *cbResolve_t )( void*, P4GoMergeData* m );

class P4GoResolveHandler
{
  public:
    P4GoResolveHandler( cbResolve_t cbResolve );
    int Resolve( P4GoMergeData* m );

  private:
    cbResolve_t cbResolve;
};

class P4GoClientUser
  : public ClientUser
  , public KeepAlive
{
  public:
    P4GoClientUser( P4GoSpecMgr* s );
    virtual ~P4GoClientUser();

    // Client User methods overridden here
    void OutputText( const char* data, int length );
    void Message( Error* e );
    void OutputStat( StrDict* values );
    void OutputBinary( const char* data, int length );
    void HandleError( Error* e );
    void InputData( StrBuf* strbuf, Error* e );
    void Diff( FileSys* f1,
               FileSys* f2,
               int doPage,
               char* diffFlags,
               Error* e );
    void Prompt( const StrPtr& msg, StrBuf& rsp, int noEcho, Error* e );

    int Resolve( ClientMerge* m, Error* e );
    int Resolve( ClientResolveA* m, int preview, Error* e );

    ClientProgress* CreateProgress( int type );
    int ProgressIndicator();

    void Finished();

    // Local methods

    void ResetInput();
    void AppendInput( char* input );

    void SetCommand( const char* c ) { cmd = c; }

    void SetApiLevel( int l );

    void SetTrack( bool t ) { track = t; }

    P4GoResults* GetResults() { return &results; }

    int ErrorCount();
    void Reset();

    // Debugging support
    void SetDebug( int d ) { debug = d; }

    // Handler support
    void SetHandler( P4GoHandler* handler );

    P4GoHandler* GetHandler() { return handler; }

    //	Progress API support
    void SetProgress( P4GoProgress* p );

    P4GoProgress* GetProgress() { return progress; }

    // SSO handler support
    void SetSSOHandler( P4GoSSOHandler* handler );
    P4GoSSOHandler* GetSSOHandler();

    // Resolve handler support
    void SetResolveHandler( P4GoResolveHandler* handler );
    P4GoResolveHandler* GetResolveHandler();

    // override from KeepAlive
    virtual int IsAlive() { return alive; }

  private:
    void* MkMergeInfo( ClientMerge* m, StrPtr& hint );
    void* MkActionMergeInfo( ClientResolveA* m, StrPtr& hint );
    void ProcessMessage( Error* e );
    void ProcessOutput( StrPtr data, bool binary );
    void ProcessOutput( StrDict* data );
    void ProcessOutput( P4GoSpecData* data );
    bool CallOutputMethod( StrPtr data, bool binary );
    bool CallOutputMethod( StrDict* data );
    bool CallOutputMethod( Error* e );
    bool CallOutputMethod( P4GoSpecData* e );

  private:
    StrBuf cmd;
    P4GoSpecMgr* specMgr;
    P4GoResults results;
    StrArray* input;
    P4GoResolveHandler* resolveHandler;
    P4GoHandler* handler;
    P4GoProgress* progress;
    int debug;
    int apiLevel;
    int alive;
    bool track;
};