resources.h

Go to the documentation of this file.

/*
 * resources.h
 *
 * Copyright 2002,2010,2011 Thomas A. Vaughan
 * All rights reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * 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.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''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 THOMAS A. VAUGHAN 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.
 *
 * Support for resources (strings, binary objects, etc.) built into the
 * executable.
 */

#ifndef WAVEPACKET_RESOURCES_H__
#define WAVEPACKET_RESOURCES_H__


// includes --------------------------------------------------------------------
#include "common/common.h"


////////////////////////////////////////////////////////////////////////////////
///
/// \ingroup common
///
/// \defgroup common_resources Resource APIs
///
/// These APIs support the ability to build resources (strings, binary
/// objects, etc.) directly into the binary for later reference.
///
///  - A "resource" is defined as the full contents of a specified file.
///
///  - Resources are assumed to be opaque binary data.  These could be image
///     files used for textures, font files, etc.  The point is that the
///     resource library treats all resource objects the same.
///
/// \n
/// To use resources in your library or executable, you'll need to update the
/// CMakeLists.txt file so that the resource files are built, compiled and
/// linked.
/// \code
/// \endcode
///
/// A namespace is just a string identifier, which should be reasonably unique
/// so you won't have collisions with other libraries that are declaring their
/// own resources.
///
/// Notes on the \p resource entry:
///  - \p file is a required tag
///  - if no \p type is supplied, \p string is assumed.
///  - if no \p name is supplied, it is assumed to be the same name as the
///     \p file.
///
/// \n
/// This is a very low-level API to access resources.  For a named-stream-based
/// read-only interface, see \ref restream
///
////////////////////////////////////////////////////////////////////////////////
/*@{*/


/// retrieve the number of resource namespaces
int getResourceNamespaceCount(void) throw();


/// retrieve the indexed namespace name.  Returns NULL on invalid input
const char * getResourceNamespaceName(IN int index) throw();


/// retrieve the number of resources in the specified resource namespace
int getResourceCount(IN const char * nameSpace) throw();


/// retrieve name of the indexed resource within the given resource namespace
///     returns NULL if index is invalid.
const char * getResourceName(IN const char * nameSpace,
                                IN int index) throw();


/// retrieve information about a named resource in the given namespace
///     returns 0 if name is not found
int getResourceSize(IN const char * nameSpace,
                                IN const char * name) throw();


/// retrieve resource data by name (returns NULL if not found).
///     Caller is responsible for knowing the resource size ahead of
///     time (don't rely on null terminator, etc.).
const byte_t * getResourceData(IN const char * nameSpace,
                                IN const char * name) throw();


/// register a new resource.  Caller is responsible for ensuring that the
///     resource value (raw byte buffer) is valid for the lifetime of the
///     process.  No copy is made.  If there is a collision (a resource
///     of the same name already exists), the old resource is quietly
///     overwritten.  Resources must be at least one byte.
void registerResource(IN const char * nameSpace,
                                IN const char * name,
                                IN const byte_t * value,
                                IN int bytes);


#endif  // WAVEPACKET_RESOURCES_H__