Added a few more constructors and initialization methods. Among them two
SetToImage() variants for initializing the object to the resources of the shared object file belonging to a loaded image. Should be handy for libraries and add-ons. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@16176 a95241bf-73f2-0310-859d-f6bbb57e9c96
This commit is contained in:
Ingo Weinhold
parent
55b35fb4d5
commit
1cac47bfa9
|
|
@ -1,7 +1,7 @@
|
|||
//----------------------------------------------------------------------
|
||||
// This software is part of the OpenBeOS distribution and is covered
|
||||
// by the OpenBeOS license.
|
||||
//---------------------------------------------------------------------
|
||||
/*
|
||||
* Copyright 2001-2006, Haiku Inc. All Rights Reserved.
|
||||
* Distributed under the terms of the MIT License.
|
||||
*/
|
||||
/*!
|
||||
\file Resources.h
|
||||
BResources interface declaration.
|
||||
|
|
@ -10,11 +10,9 @@
|
|||
#ifndef _RESOURCES_H
|
||||
#define _RESOURCES_H
|
||||
|
||||
#include <Entry.h>
|
||||
#include <File.h>
|
||||
|
||||
#ifdef USE_OPENBEOS_NAMESPACE
|
||||
namespace OpenBeOS {
|
||||
#endif
|
||||
#include <image.h>
|
||||
|
||||
namespace BPrivate {
|
||||
namespace Storage {
|
||||
|
|
@ -29,17 +27,27 @@ namespace BPrivate {
|
|||
|
||||
Provides an interface for accessing and manipulating resources.
|
||||
|
||||
\author <a href='mailto:bonefish@users.sf.net'>Ingo Weinhold</a>
|
||||
\author Ingo Weinhold
|
||||
|
||||
\version 0.0.0
|
||||
\version 1.0.0
|
||||
*/
|
||||
class BResources {
|
||||
public:
|
||||
BResources();
|
||||
BResources(const BFile *file, bool clobber = false);
|
||||
BResources(const char *path, bool clobber = false); // Haiku only
|
||||
BResources(const entry_ref *ref, bool clobber = false); // Haiku only
|
||||
|
||||
virtual ~BResources();
|
||||
|
||||
status_t SetTo(const BFile *file, bool clobber = false);
|
||||
status_t SetTo(const char *path, bool clobber = false); // Haiku only
|
||||
status_t SetTo(const entry_ref *ref, bool clobber = false); // Haiku only
|
||||
|
||||
// Haiku only
|
||||
status_t SetToImage(image_id image, bool clobber = false);
|
||||
status_t SetToImage(const void *codeOrDataPointer, bool clobber = false);
|
||||
|
||||
void Unset();
|
||||
status_t InitCheck() const;
|
||||
|
||||
|
|
@ -108,11 +116,4 @@ private:
|
|||
uint32 _reserved[3]; // FBC
|
||||
};
|
||||
|
||||
|
||||
#ifdef USE_OPENBEOS_NAMESPACE
|
||||
}; // namespace OpenBeOS
|
||||
#endif
|
||||
|
||||
#endif // _RESOURCES_H
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
//----------------------------------------------------------------------
|
||||
// This software is part of the OpenBeOS distribution and is covered
|
||||
// by the OpenBeOS license.
|
||||
//---------------------------------------------------------------------
|
||||
/*
|
||||
* Copyright 2001-2006, Ingo Weinhold <bonefish@cs.tu-berlin.de>.
|
||||
* All Rights Reserved. Distributed under the terms of the MIT License.
|
||||
*/
|
||||
/*!
|
||||
\file Resources.cpp
|
||||
BResources implementation.
|
||||
|
|
@ -56,7 +56,7 @@ BResources::BResources()
|
|||
The BResources object makes a copy of \a file, that is the caller remains
|
||||
owner of the BFile object.
|
||||
\param file the file
|
||||
\param clobber if \c true, the \a file is truncated to size 0
|
||||
\param clobber if \c true, the file's resources are truncated to size 0
|
||||
*/
|
||||
BResources::BResources(const BFile *file, bool clobber)
|
||||
: fFile(),
|
||||
|
|
@ -68,6 +68,38 @@ BResources::BResources(const BFile *file, bool clobber)
|
|||
SetTo(file, clobber);
|
||||
}
|
||||
|
||||
// constructor
|
||||
/*! \brief Creates a BResources object that represents the resources of the
|
||||
supplied file.
|
||||
If the \a clobber argument is \c true, the data of the file are erased
|
||||
and it is turned into an empty resource file. Otherwise \a path
|
||||
must refer either to a resource file or to an executable (ELF or PEF
|
||||
binary).
|
||||
\param path a path referring to the file
|
||||
\param clobber if \c true, the file's resources are truncated to size 0
|
||||
*/
|
||||
BResources::BResources(const char *path, bool clobber)
|
||||
{
|
||||
fContainer = new(nothrow) ResourcesContainer;
|
||||
SetTo(path, clobber);
|
||||
}
|
||||
|
||||
// constructor
|
||||
/*! \brief Creates a BResources object that represents the resources of the
|
||||
supplied file.
|
||||
If the \a clobber argument is \c true, the data of the file are erased
|
||||
and it is turned into an empty resource file. Otherwise \a ref
|
||||
must refer either to a resource file or to an executable (ELF or PEF
|
||||
binary).
|
||||
\param ref an entry_ref referring to the file
|
||||
\param clobber if \c true, the file's resources are truncated to size 0
|
||||
*/
|
||||
BResources::BResources(const entry_ref *ref, bool clobber)
|
||||
{
|
||||
fContainer = new(nothrow) ResourcesContainer;
|
||||
SetTo(ref, clobber);
|
||||
}
|
||||
|
||||
// destructor
|
||||
/*! \brief Frees all resources associated with this object
|
||||
Calls Sync() before doing so to make sure that the changes are written
|
||||
|
|
@ -93,7 +125,7 @@ BResources::~BResources()
|
|||
The BResources object makes a copy of \a file, that is the caller remains
|
||||
owner of the BFile object.
|
||||
\param file the file
|
||||
\param clobber if \c true, the \a file is truncated to size 0
|
||||
\param clobber if \c true, the file's resources are truncated to size 0
|
||||
\return
|
||||
- \c B_OK: Everything went fine.
|
||||
- \c B_BAD_VALUE: \c NULL or uninitialized \a file.
|
||||
|
|
@ -134,6 +166,139 @@ BResources::SetTo(const BFile *file, bool clobber)
|
|||
return error;
|
||||
}
|
||||
|
||||
// SetTo
|
||||
/*! \brief Re-initialized the BResources object to represent the resources of
|
||||
the supplied file.
|
||||
What happens, if \a clobber is \c true, depends on the type of the file.
|
||||
If the file is capable of containing resources, that is, is a resource
|
||||
file or an executable (ELF or PEF), its resources are removed. Otherwise
|
||||
the file's data are erased and it is turned into an empty resource file.
|
||||
If \a clobber is \c false, \a path must refer to a file that is capable
|
||||
of containing resources.
|
||||
\param path a path referring to the file
|
||||
\param clobber if \c true, the file's resources are truncated to size 0
|
||||
\return
|
||||
- \c B_OK: Everything went fine.
|
||||
- \c B_BAD_VALUE: \c NULL \a path.
|
||||
- \c B_ENTRY_NOT_FOUND: The file couldn't be found.
|
||||
- \c B_ERROR: Failed to initialize the object (for whatever reason).
|
||||
*/
|
||||
status_t
|
||||
BResources::SetTo(const char *path, bool clobber)
|
||||
{
|
||||
if (!path)
|
||||
return B_BAD_VALUE;
|
||||
|
||||
// open file
|
||||
BFile file;
|
||||
status_t error = file.SetTo(path, B_READ_WRITE);
|
||||
if (error != B_OK) {
|
||||
Unset();
|
||||
return error;
|
||||
}
|
||||
|
||||
// delegate the actual work
|
||||
return SetTo(&file, clobber);
|
||||
}
|
||||
|
||||
// SetTo
|
||||
/*! \brief Re-initialized the BResources object to represent the resources of
|
||||
the supplied file.
|
||||
What happens, if \a clobber is \c true, depends on the type of the file.
|
||||
If the file is capable of containing resources, that is, is a resource
|
||||
file or an executable (ELF or PEF), its resources are removed. Otherwise
|
||||
the file's data are erased and it is turned into an empty resource file.
|
||||
If \a clobber is \c false, \a ref must refer to a file that is capable
|
||||
of containing resources.
|
||||
\param ref an entry_ref referring to the file
|
||||
\param clobber if \c true, the file's resources are truncated to size 0
|
||||
\return
|
||||
- \c B_OK: Everything went fine.
|
||||
- \c B_BAD_VALUE: \c NULL \a ref.
|
||||
- \c B_ENTRY_NOT_FOUND: The file couldn't be found.
|
||||
- \c B_ERROR: Failed to initialize the object (for whatever reason).
|
||||
*/
|
||||
status_t
|
||||
BResources::SetTo(const entry_ref *ref, bool clobber)
|
||||
{
|
||||
if (!ref)
|
||||
return B_BAD_VALUE;
|
||||
|
||||
// open file
|
||||
BFile file;
|
||||
status_t error = file.SetTo(ref, B_READ_WRITE);
|
||||
if (error != B_OK) {
|
||||
Unset();
|
||||
return error;
|
||||
}
|
||||
|
||||
// delegate the actual work
|
||||
return SetTo(&file, clobber);
|
||||
}
|
||||
|
||||
// SetToImage
|
||||
/*! \brief Re-initialized the BResources object to represent the resources of
|
||||
the file from which the specified image has been loaded.
|
||||
If \a clobber is \c true, the file's resources are removed.
|
||||
\param image ID of a loaded image
|
||||
\param clobber if \c true, the file's resources are truncated to size 0
|
||||
\return
|
||||
- \c B_OK: Everything went fine.
|
||||
- \c B_ENTRY_NOT_FOUND: The file couldn't be found.
|
||||
- \c B_ERROR: Failed to initialize the object (for whatever reason).
|
||||
*/
|
||||
status_t
|
||||
BResources::SetToImage(image_id image, bool clobber)
|
||||
{
|
||||
// get an image info
|
||||
image_info info;
|
||||
status_t error = get_image_info(image, &info);
|
||||
if (error != B_OK) {
|
||||
Unset();
|
||||
return error;
|
||||
}
|
||||
|
||||
// delegate the actual work
|
||||
return SetTo(info.name, clobber);
|
||||
}
|
||||
|
||||
/*! \brief Re-initialized the BResources object to represent the resources of
|
||||
the file from which the specified image has been loaded.
|
||||
The image belongs to the current team and is identified by a pointer into
|
||||
it's code (aka text) or data segment, i.e. any pointer to a function or a
|
||||
static (or global) variable will do.
|
||||
If \a clobber is \c true, the file's resources are removed.
|
||||
\param codeOrDataPointer pointer into the text or data segment of the image
|
||||
\param clobber if \c true, the file's resources are truncated to size 0
|
||||
\return
|
||||
- \c B_OK: Everything went fine.
|
||||
- \c B_BAD_VALUE: \c NULL \a ref.
|
||||
- \c B_ENTRY_NOT_FOUND: The image or the file couldn't be found.
|
||||
- \c B_ERROR: Failed to initialize the object (for whatever reason).
|
||||
*/
|
||||
status_t
|
||||
BResources::SetToImage(const void *codeOrDataPointer, bool clobber)
|
||||
{
|
||||
if (!codeOrDataPointer)
|
||||
return B_BAD_VALUE;
|
||||
|
||||
// iterate through the images and find the one in question
|
||||
addr_t address = (addr_t)codeOrDataPointer;
|
||||
image_info info;
|
||||
int32 cookie = 0;
|
||||
|
||||
while (get_next_image_info(B_CURRENT_TEAM, &cookie, &info) == B_OK) {
|
||||
if ((addr_t)info.text <= address
|
||||
&& address - (addr_t)info.text < (addr_t)info.text_size
|
||||
|| (addr_t)info.data <= address
|
||||
&& address - (addr_t)info.data < (addr_t)info.data_size) {
|
||||
return SetTo(info.name, clobber);
|
||||
}
|
||||
}
|
||||
|
||||
return B_ENTRY_NOT_FOUND;
|
||||
}
|
||||
|
||||
// Unset
|
||||
/*! \brief Returns the BResources object to an uninitialized state.
|
||||
If the object represented resources that had been modified, the data are
|
||||
|
|
|
|||
Loading…
Reference in New Issue