p4ruby 2022.1.2359956-x64-mingw-ucrt

data/ext/P4/p4clientapi.h

@@ -0,0 +1,263 @@
+/*******************************************************************************
+
+Copyright (c) 2001-2008, 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.
+
+*******************************************************************************/
+
+/*******************************************************************************
+ * Name		: p4clientapi.h
+ *
+ * Author	: Tony Smith <tony@perforce.com> or <tony@smee.org>
+ *
+ * Description	: Ruby bindings for the Perforce API. Definitions of our
+ * 		  main interface to Perforce
+ *
+ ******************************************************************************/
+
+
+/*******************************************************************************
+ * P4ClientApi class - where we register our Ruby classes and plumb together
+ * the components
+ ******************************************************************************/
+
+class Enviro;
+class P4ClientApi
+{
+public:
+    P4ClientApi();
+    ~P4ClientApi();
+
+    // Tagged mode - can be enabled/disabled on a per-command basis
+    void Tagged( int enable );
+    int	 IsTagged()			{ return IsTag();		}
+
+    // Set track mode - track usage of this command on the server
+    int SetTrack( int enable );
+    int GetTrack()			{ return IsTrackMode() != 0;    }
+
+    // Set streams mode
+    void SetStreams( int enable );
+    int IsStreams() 			{ return IsStreamsMode() != 0;    };
+
+    // Set graph mode
+    void SetGraph( int enable );
+    int IsGraph()             { return IsGraphMode() != 0;    };
+
+    // Returns bool, but may raise exception
+    int  SetCharset( const char *c );
+
+    // Set API level for backwards compatibility
+    void SetApiLevel( int level );
+
+    void SetClient( const char *c )	{ client.SetClient( c );	}
+    void SetCwd( const char *c );
+    void SetEnviroFile( const char *c );
+    void SetEVar( const char *var, const char *val );
+    void SetHost( const char *h )	{ client.SetHost( h );		}
+    void SetIgnoreFile( const char *f )	{ client.SetIgnoreFile( f );	}
+    void SetMaxResults( int v )		{ maxResults = v;		}
+    void SetMaxScanRows( int v )	{ maxScanRows = v;		}
+    void SetMaxLockTime( int v )	{ maxLockTime = v;		}
+    VALUE SetEnv( const char *var, const char *val );
+    void SetLanguage( const char *l )	{ client.SetLanguage( l );	}
+    void SetPassword( const char *p )	{ client.SetPassword( p );	}
+    void SetPort( const char *p )	{ client.SetPort( p );		}
+    void SetProg( const char *p )	{ prog = p;			}
+    void SetProtocol( const char *var, const char *val );
+    void SetTicketFile( const char *p );
+    void SetTrustFile( const char *p );
+    void SetUser( const char *u )	{ client.SetUser( u );		}
+    void SetVersion( const char *v )	{ version = v;			}
+    void SetArrayConversion ( int i );
+
+    int	 GetApiLevel()			{ return apiLevel;		}
+    const StrPtr &GetCharset()		{ return client.GetCharset();	}
+    const StrPtr &GetClient()		{ return client.GetClient();	}
+    const StrPtr &GetConfig()		{ return client.GetConfig();	}
+    const StrPtr &GetCwd()		{ return client.GetCwd();	}
+    const char * GetEnv( const char *v);
+    const StrPtr *GetEnviroFile();
+    const StrPtr *GetEVar(const char *v);
+    const StrPtr &GetHost()		{ return client.GetHost();	}
+    const StrPtr &GetIgnoreFile()	{ return client.GetIgnoreFile();}
+    const StrPtr &GetLanguage()		{ return client.GetLanguage();	}
+    const StrPtr &GetPassword()		{ return client.GetPassword();	}
+    const StrPtr &GetPort()		{ return client.GetPort();	}
+    const StrPtr &GetProg()		{ return prog;			}
+    const StrPtr &GetTicketFile()	{ return ticketFile;		}
+    const StrPtr &GetTrustFile()   { return trustFile;        }
+    const StrPtr &GetUser()		{ return client.GetUser();	}
+    const StrPtr &GetVersion()		{ return version;		}
+
+    int		  IsIgnored( const char *path );
+
+    int		  GetMaxResults()	{ return maxResults;		}
+    int		  GetMaxScanRows()	{ return maxScanRows;		}
+    int		  GetMaxLockTime()	{ return maxLockTime;		}
+    int		  GetServerLevel();
+    int		  ServerCaseSensitive();
+    int		  ServerUnicode();
+
+
+    // Session management
+    VALUE Connect();		// P4Exception on error
+    VALUE Connected();		// Return true if connected and not dropped.
+    VALUE Disconnect();
+
+    // Executing commands.
+    VALUE Run( const char *cmd, int argc, char * const *argv );
+    VALUE SetInput( VALUE input );
+
+    // Result handling
+    VALUE GetErrors()		{ return ui.GetResults().GetErrors();}
+    VALUE GetWarnings()		{ return ui.GetResults().GetWarnings();}
+    VALUE GetMessages()		{ return ui.GetResults().GetMessages();}
+    VALUE GetTrackOutput()	{ return ui.GetResults().GetTrack();}
+
+    // Spec parsing
+    VALUE ParseSpec( const char * type, const char *form );
+    VALUE FormatSpec( const char *type, VALUE hash );
+    VALUE SpecFields( const char * type );
+
+    // Exception levels:
+    //
+    // 		0 - No exceptions raised
+    // 		1 - Exceptions raised for errors
+    // 		2 - Exceptions raised for errors and warnings
+    //
+    void  ExceptionLevel( int i )	{ exceptionLevel = i; 	}
+    int   ExceptionLevel()		{ return exceptionLevel; }
+
+    void  Except( const char *func, Error *e );
+    void  Except( const char *func, const char *msg );
+    void  Except( const char *func, const char *msg, const char *cmd );
+
+    //
+    // Debugging support. Debug levels are:
+    //
+    //     1:	Debugs commands being executed
+    //     2:	Debug UI method calls
+    //     3:	Show garbage collection
+    //
+    int   GetDebug() { return debug; }
+    void  SetDebug( int d );
+
+    // Handler support
+
+    VALUE SetHandler( VALUE handler );
+    VALUE GetHandler() { return ui.GetHandler(); }
+
+    //	Progress API support
+    VALUE SetProgress( VALUE progress );
+    VALUE GetProgress() { return ui.GetProgress(); }
+
+    // SSO handler
+    VALUE SetEnableSSO( VALUE e );
+    VALUE GetEnableSSO();
+    VALUE GetSSOVars();
+    VALUE SetSSOPassResult( VALUE r );
+    VALUE GetSSOPassResult();
+    VALUE SetSSOFailResult( VALUE r );
+    VALUE GetSSOFailResult();
+    VALUE SetSSOHandler( VALUE handler );
+    VALUE GetSSOHandler() { return ui.GetRubySSOHandler(); }
+
+    // Ruby garbage collection
+    void  GCMark();
+
+
+private:
+
+    void RunCmd(const char *cmd, ClientUser *ui, int argc, char * const *argv);
+
+    VALUE ConnectOrReconnect();	// internal connect method
+
+    enum {
+	S_TAGGED 	= 0x0001,
+	S_CONNECTED	= 0x0002,
+	S_CMDRUN	= 0x0004,
+	S_UNICODE	= 0x0008,
+	S_CASEFOLDING	= 0x0010,
+	S_TRACK		= 0x0020,
+	S_STREAMS	= 0x0040,
+    S_GRAPH     = 0x0080,
+
+	S_INITIAL_STATE	= 0x00C1,   // Streams, Graph, and Tagged enabled by default
+	S_RESET_MASK	= 0x001E,
+    };
+
+    void	InitFlags()		{ flags = S_INITIAL_STATE;	}
+    void	ResetFlags()		{ flags &= ~S_RESET_MASK;	}
+
+    void	SetTag()		{ flags |= S_TAGGED;		}
+    void	ClearTag()		{ flags &= ~S_TAGGED;		}
+    int		IsTag()			{ return flags & S_TAGGED;	}
+
+    void	SetConnected()		{ flags |= S_CONNECTED;		}
+    void	ClearConnected() 	{ flags &= ~S_CONNECTED;	}
+    int		IsConnected()		{ return flags & S_CONNECTED;	}
+
+    void	SetCmdRun()		{ flags |= S_CMDRUN;		}
+    void	ClearCmdRun() 		{ flags &= ~S_CMDRUN;		}
+    int		IsCmdRun()		{ return flags & S_CMDRUN;	}
+
+    void	SetUnicode()		{ flags |= S_UNICODE;		}
+    void	ClearUnicode() 		{ flags &= ~S_UNICODE;		}
+    int		IsUnicode()		{ return flags & S_UNICODE;	}
+
+    void	SetCaseFold()		{ flags |= S_CASEFOLDING;	}
+    void	ClearCaseFold()		{ flags &= ~S_CASEFOLDING;	}
+    int		IsCaseFold()		{ return flags & S_CASEFOLDING;	}
+
+    void	SetTrackMode()		{ flags |= S_TRACK;		}
+    void	ClearTrackMode()	{ flags &= ~S_TRACK;		}
+    int		IsTrackMode()		{ return flags & S_TRACK;	}
+
+    void	SetStreamsMode()	{ flags |= S_STREAMS;		}
+    void	ClearStreamsMode()	{ flags &= ~S_STREAMS;		}
+    int		IsStreamsMode()		{ return flags & S_STREAMS;	}
+
+    void    SetGraphMode()    { flags |= S_GRAPH;       }
+    void    ClearGraphMode()  { flags &= ~S_GRAPH;      }
+    int     IsGraphMode()     { return flags & S_GRAPH; }
+
+    private:
+    ClientApi		client;
+    ClientUserRuby	ui;
+    Enviro *		enviro;
+    SpecMgr		specMgr;
+    StrBuf		prog;
+    StrBuf		version;
+    StrBuf		ticketFile;
+    StrBuf      trustFile;
+    int			depth;
+    int			debug;
+    int			exceptionLevel;
+    int			apiLevel;
+    int			server2;
+    int			flags;
+    int			maxResults;
+    int			maxScanRows;
+    int			maxLockTime;
+};

data/ext/P4/p4error.cpp

@@ -0,0 +1,137 @@
+/*******************************************************************************
+
+Copyright (c) 2010, 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.
+
+*******************************************************************************/
+
+/*******************************************************************************
+ * Name		: p4error.cc
+ *
+ * Author	: Tony Smith <tony@perforce.com> or <tony@smee.org>
+ *
+ * Description	: Class for bridging Perforce's Error class to Ruby
+ *
+ ******************************************************************************/
+#include <ruby.h>
+#include "undefdups.h"
+#include <p4/clientapi.h>
+#include "p4rubydebug.h"
+#include "p4utils.h"
+#include "p4error.h"
+
+
+static void error_free( P4Error *e )
+{
+    delete e;
+}
+
+static void error_mark( P4Error *e )
+{
+    e->GCMark();
+}
+
+
+P4Error::P4Error( const Error &other )
+{
+    this->debug = 0;
+
+    error = other;
+}
+
+VALUE
+P4Error::GetId()
+{
+    ErrorId *id = error.GetId( 0 );
+    if( !id )
+	return INT2NUM( 0 );
+    return INT2NUM( id->UniqueCode() );
+}
+
+VALUE
+P4Error::GetGeneric()
+{
+    return INT2NUM( error.GetGeneric() );
+}
+
+VALUE
+P4Error::GetSeverity()
+{
+    return INT2NUM( error.GetSeverity() );
+}
+
+VALUE
+P4Error::GetText()
+{
+    StrBuf t;
+    error.Fmt( t, EF_PLAIN );
+    return P4Utils::ruby_string( t.Text(), t.Length() );
+}
+
+VALUE
+P4Error::GetDict()
+{
+    VALUE dictHash = rb_hash_new();
+    StrDict* pDict = error.GetDict();
+    StrRef key, val;
+    // suppress -Wpointer-arith
+    for (int i=0;pDict->GetVar(i,key,val) != 0;i++) {
+      rb_hash_aset( dictHash,
+        P4Utils::ruby_string(key.Text(), key.Length()),
+        P4Utils::ruby_string(val.Text(), val.Length()));
+    }
+    return dictHash;
+}
+
+VALUE
+P4Error::Inspect()
+{
+    StrBuf a;
+    StrBuf b;
+
+    error.Fmt( a, EF_PLAIN );
+    b << "[";
+    b << "Gen:" << error.GetGeneric();
+    b << "/Sev:" << error.GetSeverity();
+    b << "]: ";
+    b << a;
+    return P4Utils::ruby_string( b.Text(), b.Length() );
+}
+
+VALUE
+P4Error::Wrap( VALUE pClass )
+{
+    VALUE e;
+    VALUE argv[ 1 ];
+
+    e = Data_Wrap_Struct( pClass, error_mark, error_free, this );
+    rb_obj_call_init( e, 0, argv );
+    return e;
+}
+
+void
+P4Error::GCMark()
+{
+    // We don't hold Ruby objects
+}
+

data/ext/P4/p4error.h

@@ -0,0 +1,62 @@
+/*******************************************************************************
+
+Copyright (c) 2010, 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.
+
+*******************************************************************************/
+
+/*******************************************************************************
+ * Name		: p4error.h
+ *
+ * Author	: Tony Smith <tony@perforce.com> or <tony@smee.org>
+ *
+ * Description	: Class for bridging Perforce's Error class to Ruby
+ *
+ ******************************************************************************/
+
+class P4Error
+{
+    public:
+    // Construct by copying another error object
+    P4Error( const Error &other );
+
+    void  SetDebug( int d )	{ debug = d;	}
+
+    VALUE	GetId();
+    VALUE	GetGeneric();
+    VALUE	GetSeverity();
+    VALUE	GetText();
+    VALUE   GetDict();
+    VALUE	Inspect();
+
+    // Wrap as Ruby object of class pClass
+    VALUE	Wrap( VALUE pClass );
+
+    // Ruby garbage collection
+    void  GCMark();
+
+    private:
+    Error		error;
+    int			debug;
+};
+