Table of Contents Preface About This Manual Please give us feedback Chapter 1 P4Ruby Introduction System Requirements Installing P4Ruby Programming with P4Ruby P4Ruby classes P4 P4Exception P4::DepotFile P4::Revision P4::Integration P4::Map P4::MergeData P4::Spec Class P4 Description Class Methods P4.identify -> aString P4.new -> aP4 Instance Methods p4.api_level= anInteger -> anInteger p4.api_level -> anInteger p4.at_exception_level( lev ) { ... } -> self p4.charset= aString -> aString p4.charset -> aString p4.client= aString -> aString p4.client -> aString p4.connect -> aBool p4.connected? -> aBool p4.cwd= aString -> aString p4.cwd -> aString p4.delete_<spectype>( [options], name ) -> anArray p4.disconnect -> true p4.env -> string p4.errors -> anArray p4.exception_level= anInteger -> anInteger p4.exception_level -> aNumber p4.fetch_<spectype>( [name] ) -> aP4::Spec p4.format_spec( <spectype>, aHash )-> aString p4.format_<spectype> aHash -> aHash p4.host= aString -> aString p4.host -> aString p4.input= ( aString|aHash|anArray ) -> aString|aHash|anArray p4.maxlocktime= anInteger -> anInteger p4.maxlocktime -> anInteger p4.maxresults= anInteger -> anInteger p4.maxresults -> anInteger p4.maxscanrows= anInteger -> anInteger p4.maxscanrows -> anInteger p4.p4config_file -> aString p4.parse_<spectype> ( aString ) -> aP4::Spec p4.parse_spec( <spectype>, aString ) -> aP4::Spec p4.password= aString -> aString p4.password -> aString p4.port= aString -> aString p4.port -> aString p4.prog= aString -> aString p4.prog -> aString p4.run_cmd( arguments ) -> anArray p4.run( aCommand, arguments... ) -> anArray p4.run_filelog( fileSpec ) -> anArray p4.run_login( arg... ) -> anArray p4.run_password( oldpass, newpass ) -> anArray p4.run_resolve( args ) [ block ] -> anArray p4.run_submit( [aHash], [arg...] ) -> anArray p4.save_<spectype>( hashOrString, [options] ) -> anArray p4.server_level -> anInteger p4.tagged( aBool ) { block } p4.tagged= aBool -> aBool p4.tagged? -> aBool p4.ticketfile= aString -> aString p4.ticketfile -> aString p4.user= aString -> aString p4.user -> aString p4.version= aString -> aString p4.version -> aString p4.warnings -> anArray Class P4Exception Class Methods Instance Methods Class P4::DepotFile Description Class Methods Instance Methods df.depot_file -> aString df.each_revision { |rev| block } -> revArray df.revisions -> aArray Class P4::Revision Description Class Methods Instance Methods rev.action -> aString rev.change -> aNumber rev.client -> aString rev.depot_file -> aString rev.desc -> aString rev.digest -> aString rev.each_integration { |integ| block } -> integArray rev.filesize -> aNumber rev.integrations -> integArray rev.rev -> aNumber rev.time -> aTime rev.type -> aString rev.user -> aString Class P4::Integration Description Class Methods Instance Methods integ.how -> aString integ.file -> aPath integ.srev -> aNumber integ.erev -> aNumber Class P4::Map Description Class Methods Map.new ( [ anArray ] ) -> aMap Map.join ( map1, map2 ) -> aMap Instance Methods map.clear -> true map.count -> anInteger map.empty? -> aBool map.insert( aString, [ aString ] ) -> aMap map.translate ( aString, [ aBool ] )-> aString map.includes? ( aString ) -> aBool map.reverse -> aMap map.lhs -> anArray map.rhs -> anArray map.to_a -> anArray Class P4::MergeData Description Class Methods Instance Methods md.your_name() -> aString md.their_name() -> aString md.base_name() -> aString md.your_path() -> aString md.their_path() -> aString md.base_path() -> aString md.result_path() -> aString md.merge_hint() -> aString md.run_merge() -> aBool Class P4::Spec Description Class Methods new P4::Spec.new( anArray ) -> aP4::Spec Instance Methods spec._<fieldname> -> aValue spec._<fieldname>= aValue -> aValue spec.permitted_fields -> anArray Chapter 2 P4Perl Introduction System Requirements Installing P4Perl Programming with P4Perl P4Perl Classes P4 P4::DepotFile P4::Revision P4::Integration P4::Map P4::MergeData P4::Resolver P4::Spec Class P4 Description Base methods P4::new() -> P4 P4::Identify() -> string P4::Connect() -> bool P4::Disconnect() -> undef P4::ErrorCount() -> integer P4::Errors() -> list P4::Fetch<spectype>( [name] ) -> hashref P4::Format<spectype>( hash ) -> string P4::FormatSpec( $spectype, $string ) -> string P4::GetApiLevel() -> integer P4::GetCharset() -> string P4::GetClient() -> string P4::GetCwd() -> string P4::GetEnv( $var ) -> string P4::GetHost() -> string P4::GetMaxLockTime( $value ) -> integer P4::GetMaxResults( $value ) -> integer P4::GetMaxScanRows( $value ) -> integer P4::GetPassword() -> string P4::GetPort() -> string P4::GetProg() -> string P4::GetTicketFile( [$string] ) -> string P4::GetUser() -> String P4::GetVersion ( $string ) -> string P4::IsConnected() -> bool P4::IsTagged() -> bool P4::P4ConfigFile() -> string P4::Parse<Spectype>( $string ) -> hashref P4::ParseSpec( $spectype, $string ) -> hashref P4::Run<cmd>( [ $arg... ] ) -> list | arrayref P4::Run( cmd, [ $arg... ] ) -> list | arrayref P4::RunFilelog ( [$args ...], $fileSpec ... ) -> list | arrayref P4::RunLogin (...) -> list | arrayref P4::RunPassword ( $oldpass, $newpass ) -> list | arrayref P4::RunResolve ( [$resolver], [$args ...] ) -> string P4::RunSubmit ( $arg | $hashref, ...) -> list | arrayref P4::Save<Spectype>() -> list | arrayref P4::ServerLevel() -> integer P4::SetApiLevel( $integer ) -> undef P4::SetCharset( $charset ) -> undef P4::SetClient( $client ) -> undef P4::SetCwd( $path ) -> undef P4::SetHost( $hostname ) -> undef P4::SetInput( $string | $hashref | $arrayref ) -> undef P4::SetMaxLockTime( $integer ) -> undef P4::SetMaxResults( $integer ) -> undef P4::SetMaxScanRows( $integer ) -> undef P4::SetPassword( $password ) -> undef P4::SetPort( $port ) -> undef P4::SetProg( $program_name ) -> undef P4::SetTicketFile( [$string] ) -> string P4::SetUser( $username ) -> undef P4::SetVersion ( $version ) -> undef P4::Tagged( 0 | 1 | $coderef ) -> undef P4::WarningCount() -> integer P4::Warnings() -> list Class P4::DepotFile Description Class Methods Instance Methods $df->DepotFile() -> string $df->Revisions() -> array Class P4::Revision Description Class Methods $rev->Integrations() -> array Instance Methods $rev->Action() -> string $rev->Change() -> integer $rev->Client() -> string $rev->DepotFile() -> string $rev->Desc() -> string $rev->Digest() -> string $rev->FileSize() -> string $rev->Rev() -> integer $rev->Time() -> string $rev->Type() -> string $rev->User() Class P4::Integration Description Class Methods Instance Methods $integ->How() -> string $integ->File() -> string $integ->SRev() -> integer $integ->ERev() -> integer Class P4::Map Description Class Methods $map = new P4::Map( [ array ] ) -> aMap $map->Join( map1, map2 ) -> aMap Instance Methods $map->Clear() -> undef $map->Count() -> integer $map->IsEmpty() -> bool $map->Insert( string ... ) -> undef $map->Translate( string, [ bool ] ) -> string $map->Includes( string ) -> bool $map->Reverse() -> aMap $map->Lhs() -> array $map->Rhs() -> array $map->AsArray() -> array Class P4::MergeData Description Class Methods Instance Methods $md.YourName() -> string $md.TheirName() -> string $md.BaseName() -> string $md.YourPath() -> string $md.TheirPath() -> string $md.BasePath() -> string $md.ResultPath() -> string $md.MergeHint() -> string $md.RunMergeTool() -> integer Class P4::Resolver Description Class Methods Instance Methods $resolver.Resolve() -> string Class P4::Spec Description Class Methods $spec = new P4::Spec( $fieldMap ) -> array Instance Methods $spec->_<fieldname> -> string $spec->_<fieldname>( $string )-> string $spec->PermittedFields() -> array Chapter 3 P4Python Introduction System Requirements Installing P4Python Programming with P4Python Submitting a Changelist Logging into Perforce using ticket-based authentication Changing your password Timestamp conversion P4Python Classes P4 P4.P4Exception P4.DepotFile P4.Revision P4.Integration P4.Map P4.MergeData P4.Resolver P4.Spec Class P4 Description Instance Attributes p4.api_level -> int p4.charset -> string p4.client -> string p4.cwd -> string p4.errors -> list (read-only) p4.exception_level -> int p4.host -> string p4.input -> string | dict | list p4.maxlocktime -> int p4.maxresults -> int p4.maxscanrows -> int p4.p4config_file -> string (read-only) p4.password -> string p4.port -> string p4.prog -> string p4.server_level -> int (read-only) p4.tagged -> int p4.ticket_file -> string p4.user -> string p4.version -> string p4.warnings -> list (read-only) Class Methods P4.P4() P4.identify() Instance Methods p4.at_exception_level() p4.connect() p4.connected() -> boolean p4.delete_<spectype>( [ options ], name ) -> list p4.disconnect() p4.env( var ) p4.fetch_<spectype>() -> P4.Spec p4.format_spec( <spectype>, dict ) -> string p4.format_<spectype>( dict ) -> string p4.parse_spec( <spectype>, string ) -> P4.Spec p4.parse_<spectype>( string ) -> P4.Spec p4.run(cmd, [arg, ...]) p4.run_<cmd>() p4.run_filelog(<fileSpec >) -> list p4.run_login( arg... ) -> list p4.run_password( oldpass, newpass ) -> list p4.run_resolve( [resolver], [arg...] ) -> list p4.run_submit( [ hash ], [ arg... ] ) -> list p4.save_<spectype>()> p4.while_tagged( boolean ) Class P4.P4Exception Description Class Attributes Class Methods Class P4.DepotFile Description Instance Attributes df.depotFile -> string df.revisions -> list Class Methods Instance Methods Class P4.Revision Description Instance Attributes rev.action -> string rev.change -> int rev.client -> string rev.depotFile -> string rev.desc -> string rev.digest -> string rev.fileSize -> string rev.integrations -> list rev.rev -> int rev.time -> datetime rev.type -> string rev.user -> string Class Methods Instance Methods Class P4.Integration Description Instance Attributes integ.how -> string integ.file -> string integ.srev -> int integ.erev -> int Class Methods Instance Methods Class P4.Map Description Instance Attributes Class Methods P4.Map( [ list ] ) -> P4.Map P4.Map.join ( map1, map2 ) -> P4.Map Instance Methods map.clear() map.count() -> int map.is_empty() -> boolean map.insert( string ... ) map.translate ( string, [ boolean ] )-> string map.includes( string ) -> boolean map.reverse() -> P4.Map map.lhs() -> list map.rhs() -> list map.as_array() -> list Class P4.MergeData Description Instance Attributes md.your_name -> string md.their_name -> string md.base_name -> string md.your_path -> string md.their_path -> string md.base_path -> string md.result_path -> string md.merge_hint -> string Instance Methods md.run_merge() -> boolean Class P4.Resolver Description Instance Attributes Class Methods Instance Methods resolver.resolve(self, mergeData) -> string Class P4.Spec Description Instance Attributes spec._<fieldname> -> string spec.permitted_fields -> dict Class Methods P4.Spec.new( dict ) ->P4.Spec Instance Methods
