ai_string.h

Go to the documentation of this file.

// Copyright 2021 Autodesk, Inc.  All rights reserved.
//
// Use of this software is subject to the terms of the Autodesk license
// agreement provided at the time of installation or download, or which
// otherwise accompanies this software in either electronic or hard copy form.
 
#pragma once
#include "ai_api.h"
 
#include <stddef.h> 
 
//  Do not use these functions directly.  Instead use the AtString class
AI_API         const char* AiCreateAtStringData_private(const char*);
AI_API AI_PURE size_t      AiAtStringLength(const char*);
AI_API AI_PURE AI_DEVICE size_t AiAtStringHash(const char*);
 
class AtString {
public:
   AI_DEVICE AtString() : data(NULL) { }
 
   explicit AtString(const char* str) { data = AiCreateAtStringData_private(str); }
 
   AI_DEVICE bool operator== (const AtString &rhs) const { return data == rhs.data; }
   AI_DEVICE bool operator!= (const AtString &rhs) const { return data != rhs.data; }
   size_t length() const { return AiAtStringLength(data); }
 
#ifdef AI_CPU_COMPILER
   bool empty() const { return length() == 0; }
#else
   AI_DEVICE bool empty() const;
#endif
 
   operator const char*() const { return c_str(); }
   AI_DEVICE const char* c_str() const { return data; }
 
   AI_DEVICE void clear() { data = NULL; }
 
   AI_DEVICE size_t hash() const { return AiAtStringHash(data); }
 
private:
   const char* data;
   friend void setAtStringInternalData(AtString &str, const char* data);
 
   // Comparing a char* with an AtString is not allowed since this would
   // require using a strcmp or casting the char* to AtString.  Both of these
   // are slow and users expect comparisons with AtString to be fast.  Since it
   // is too easy to accidentally do this slow comparison without realizing
   // it's slow, we make this a compiler error.  Note these are not defined on
   // purpose so that using these functions will cause a linker error.
   bool operator== (const char* rhs) const;
   bool operator!= (const char* rhs) const;
   AI_UNAVAILABLE friend inline bool operator==(const char* lhs, const AtString& rhs);
   AI_UNAVAILABLE friend inline bool operator!=(const char* lhs, const AtString& rhs);
};
 
class AtStringHash
{
public:
    size_t operator() (const AtString &s) const { return s.hash(); }
};
/*\}*/