historical/toontown-classic.git/panda/include/internalName.h
2024-01-16 11:20:27 -06:00

219 lines
7.6 KiB
C++

/**
* PANDA 3D SOFTWARE
* Copyright (c) Carnegie Mellon University. All rights reserved.
*
* All use of this software is subject to the terms of the revised BSD
* license. You should have received a copy of this license along
* with this source code in a file named "LICENSE."
*
* @file internalName.h
* @author drose
* @date 2004-07-15
*/
#ifndef INTERNALNAME_H
#define INTERNALNAME_H
#include "pandabase.h"
#include "typedWritableReferenceCount.h"
#include "pointerTo.h"
#include "pmap.h"
#include "lightMutex.h"
#include "lightMutexHolder.h"
class FactoryParams;
/**
* Encodes a string name in a hash table, mapping it to a pointer. This is
* used to tokenify names so they may be used efficiently in low-level Panda
* structures, for instance to differentiate the multiple sets of texture
* coordinates that might be stored on a Geom.
*
* InternalNames are hierarchical, with the '.' used by convention as a
* separator character. You can construct a single InternalName as a
* composition of one or more other names, or by giving it a source string
* directly.
*/
class EXPCL_PANDA_GOBJ InternalName final : public TypedWritableReferenceCount {
private:
InternalName(InternalName *parent, const std::string &basename);
public:
INLINE static PT(InternalName) make(const std::string &name);
template<int N>
INLINE static PT(InternalName) make(const char (&literal)[N]);
PUBLISHED:
virtual ~InternalName();
virtual bool unref() const;
static PT(InternalName) make(const std::string &name, int index);
PT(InternalName) append(const std::string &basename);
INLINE InternalName *get_parent() const;
std::string get_name() const;
std::string join(const std::string &sep) const;
INLINE const std::string &get_basename() const;
MAKE_PROPERTY(parent, get_parent);
MAKE_PROPERTY(name, get_name);
MAKE_PROPERTY(basename, get_basename);
int find_ancestor(const std::string &basename) const;
const InternalName *get_ancestor(int n) const;
const InternalName *get_top() const;
std::string get_net_basename(int n) const;
void output(std::ostream &out) const;
// Some predefined built-in names.
INLINE static PT(InternalName) get_root();
INLINE static PT(InternalName) get_error();
INLINE static PT(InternalName) get_vertex();
INLINE static PT(InternalName) get_normal();
INLINE static PT(InternalName) get_tangent();
INLINE static PT(InternalName) get_tangent_name(const std::string &name);
INLINE static PT(InternalName) get_binormal();
INLINE static PT(InternalName) get_binormal_name(const std::string &name);
INLINE static PT(InternalName) get_texcoord();
INLINE static PT(InternalName) get_texcoord_name(const std::string &name);
INLINE static PT(InternalName) get_color();
INLINE static PT(InternalName) get_rotate();
INLINE static PT(InternalName) get_size();
INLINE static PT(InternalName) get_aspect_ratio();
INLINE static PT(InternalName) get_transform_blend();
INLINE static PT(InternalName) get_transform_weight();
INLINE static PT(InternalName) get_transform_index();
INLINE static PT(InternalName) get_morph(InternalName *column, const std::string &slider);
INLINE static PT(InternalName) get_index();
INLINE static PT(InternalName) get_world();
INLINE static PT(InternalName) get_camera();
INLINE static PT(InternalName) get_model();
INLINE static PT(InternalName) get_view();
#ifdef HAVE_PYTHON
// These versions are exposed to Python, which have additional logic to map
// from Python interned strings.
EXTENSION(static PT(InternalName) make(PyObject *str));
#endif
public:
#ifdef HAVE_PYTHON
// It's OK for us to define it here since these are just pointers of which
// the reference is maintained indefinitely.
typedef phash_map<PyObject *, InternalName *, pointer_hash> PyInternTable;
static PyInternTable _py_intern_table;
#endif
private:
PT(InternalName) _parent;
std::string _basename;
typedef phash_map<std::string, InternalName *, string_hash> NameTable;
NameTable _name_table;
LightMutex _name_table_lock;
typedef phash_map<const char *, PT(InternalName), pointer_hash> LiteralTable;
static LiteralTable _literal_table;
static LightMutex _literal_table_lock;
static PT(InternalName) _root;
static PT(InternalName) _error;
static PT(InternalName) _default;
static PT(InternalName) _vertex;
static PT(InternalName) _normal;
static PT(InternalName) _tangent;
static PT(InternalName) _binormal;
static PT(InternalName) _texcoord;
static PT(InternalName) _color;
static PT(InternalName) _rotate;
static PT(InternalName) _size;
static PT(InternalName) _aspect_ratio;
static PT(InternalName) _transform_blend;
static PT(InternalName) _transform_weight;
static PT(InternalName) _transform_index;
static PT(InternalName) _index;
static PT(InternalName) _world;
static PT(InternalName) _camera;
static PT(InternalName) _model;
static PT(InternalName) _view;
public:
// Datagram stuff
static void register_with_read_factory();
virtual void write_datagram(BamWriter *manager, Datagram &me);
virtual void finalize(BamReader *manager);
protected:
static TypedWritable *make_from_bam(const FactoryParams &params);
static TypedWritable *make_texcoord_from_bam(const FactoryParams &params);
public:
static TypeHandle get_class_type() {
return _type_handle;
}
static void init_type() {
TypedWritableReferenceCount::init_type();
register_type(_type_handle, "InternalName",
TypedWritableReferenceCount::get_class_type());
// The _texcoord_type_handle is defined only to support older bam files,
// generated before we renamed the type to InternalName.
register_type(_texcoord_type_handle, "TexCoordName",
TypedWritableReferenceCount::get_class_type());
}
virtual TypeHandle get_type() const {
return get_class_type();
}
virtual TypeHandle force_init_type() {init_type(); return get_class_type();}
private:
static TypeHandle _type_handle;
static TypeHandle _texcoord_type_handle;
};
// We can safely redefine this as a no-op.
template<>
INLINE void PointerToBase<InternalName>::update_type(To *ptr) {}
INLINE std::ostream &operator << (std::ostream &out, const InternalName &tcn);
/**
* This is a const pointer to an InternalName, and should be used in lieu of a
* CPT(InternalName) in function arguments. The extra feature that it offers
* is that it has a constructor to automatically convert from a string, so
* that strings are coerced by the compiler when passed to such a function.
*/
#ifdef CPPPARSER
// The construct below confuses interrogate, so we give it a typedef.
typedef ConstPointerTo<InternalName> CPT_InternalName;
#else
class CPT_InternalName : public ConstPointerTo<InternalName> {
public:
INLINE CPT_InternalName(const To *ptr = nullptr);
INLINE CPT_InternalName(const PointerTo<InternalName> &copy);
INLINE CPT_InternalName(PointerTo<InternalName> &&from) noexcept;
INLINE CPT_InternalName(const ConstPointerTo<InternalName> &copy);
INLINE CPT_InternalName(ConstPointerTo<InternalName> &&from) noexcept;
INLINE CPT_InternalName(const std::string &name);
template<int N>
INLINE CPT_InternalName(const char (&literal)[N]);
INLINE CPT_InternalName &operator = (const To *ptr);
INLINE CPT_InternalName &operator = (const PointerTo<InternalName> &copy);
INLINE CPT_InternalName &operator = (const ConstPointerTo<InternalName> &copy);
INLINE CPT_InternalName &operator = (PointerTo<InternalName> &&from) noexcept;
INLINE CPT_InternalName &operator = (ConstPointerTo<InternalName> &&from) noexcept;
};
INLINE void swap(CPT_InternalName &one, CPT_InternalName &two) noexcept {
one.swap(two);
}
#endif // CPPPARSER
#include "internalName.I"
#endif