SpecMgr.h

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

Copyright (c) 2007-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.

$Id: //depot/r13.1/p4-python/SpecMgr.h#1 $
*******************************************************************************/

/*******************************************************************************
 * Name		: SpecMgr.h
 *
 * Description	: Python bindings for the Perforce API. Class for handling
 * 		  Perforce specs. This class provides other classes with
 * 		  generic support for parsing and formatting Perforce
 *		  specs.
 *
 ******************************************************************************/

#ifndef SPEC_MGR_H
#define SPEC_MGR_H

class StrBufDict;

class SpecMgr 
{
public:
	SpecMgr();
	~SpecMgr();
	
	void	SetDebug( int i )	{ debug = i; }

	void		SetEncoding( const char * e )	{ encoding = e; }
	const char *	GetEncoding()			{ return encoding.Text(); }

	PyObject * CreatePyString(const char * text);
	PyObject * CreatePyStringAndSize(const char * text, size_t len);

	// Clear the spec cache and revert to internal defaults
	void	Reset();

	// Add a spec to the cache
	void	AddSpecDef( const char *type, StrPtr &specDef );
	void	AddSpecDef( const char *type, const char * specDef );

	// Check that a type of spec is known.
	int	HaveSpecDef( const char *type );

	//
	// Parse routine: converts strings into Python P4.Spec objects.
	//
	PyObject * StringToSpec( const char *type, const char *spec, Error *e );

	//
	// Format routine. updates a StrBuf object with the form; 
	// that can then be converted to a Python string where required. 
	//
	void	SpecToString(const char *type, PyObject * pydict, StrBuf &b, Error *e);

	//
	// Convert a Perforce StrDict into a Python dict. Used when we're 
	// parsing tagged output that is NOT a spec. e.g. output of
	// fstat etc.
    //
	PyObject * StrDictToDict( StrDict *dict, PyObject * pydict = NULL );
	PyObject * StrDictToDict( StrDict *dict, PyObject * pydict, int debug );

	// 
	// Convert a Perforce StrDict into a P4.Spec object. This is for
	// 2005.2 and later servers where the forms are supplied pre-parsed
	// into a dictionary - we just need to convert them. The specDef
	// argument tells us what type of spec we're converting.
	//
	PyObject * StrDictToSpec( StrDict *dict, StrPtr *specDef );


	//
	// Return a list of the fields in a given type of spec. Return Py_None
	// if the spec type is not known.
	//
	PyObject * SpecFields( const char *type );

private:

	static void	SplitKey( const StrPtr *key, StrBuf &base, StrBuf &index );
	void	InsertItem( PyObject * pydict, const StrPtr *var, const StrPtr *val );
	void	InsertItem( PyObject * pydict, const StrPtr *var, const StrPtr *val, int debug );
	PyObject * NewSpec( StrPtr *specDef );
	PyObject * SpecFields( StrPtr *specDef );
	
private:
	StrBuf		encoding;
	int		debug;
	StrBufDict *	specs;
};

#endif