Bifrost SDK
Bifrost SDK documentation
NamingUtilities.h
Go to the documentation of this file.
1//-
2// =============================================================================
3// Copyright 2025 Autodesk, Inc. All rights reserved.
4//
5// Use of this software is subject to the terms of the Autodesk license
6// agreement provided at the time of installation or download, or which
7// otherwise accompanies this software in either electronic or hard copy form.
8// =============================================================================
9//+
10
13
14#ifndef AMINO_CORE_NAMING_UTILITIES_H
15#define AMINO_CORE_NAMING_UTILITIES_H
16
17//==============================================================================
18// EXTERNAL DECLARATIONS
19//==============================================================================
20
21#include "CoreExport.h"
22
24
25namespace Amino {
26class String;
27}
28
29namespace Amino {
30
31//==============================================================================
32// CLASS NamingUtilities
33//==============================================================================
34
36class AMINO_CORE_SHARED_DECL NamingUtilities {
37public:
61 static bool legalize(String& name);
62
71 static bool getLegalName(StringView const& name, String& legalName);
72
80 static bool isLegalName(StringView const& name);
81
82public:
85 NamingUtilities() = delete;
89};
90
91} // namespace Amino
92
93#endif
Definition of macros for symbol visibility.
String view class (similar to std::string_view)
Definition: HostData.h:33
A collection of Naming Utility methods.
NamingUtilities()=delete
NamingUtilities are static functions only.
NamingUtilities(const NamingUtilities &)=delete
NamingUtilities are static functions only.
static bool getLegalName(StringView const &name, String &legalName)
Convert a string to a legal name by removing invalid characters. See legalize for conversion details.
static bool isLegalName(StringView const &name)
Check if a name is legal.
static bool legalize(String &name)
Convert a string to a legal name by removing invalid characters.
NamingUtilities & operator=(const NamingUtilities &)=delete
NamingUtilities are static functions only.
The string class used by Amino.
Definition: String.h:46
String view class (similar to std::string_view).
Definition: StringView.h:42