mirror of
https://github.com/XRPLF/rippled.git
synced 2025-12-06 17:27:55 +00:00
Rename beast sources for consistency
This commit is contained in:
86
modules/beast_core/text/StringPool.h
Normal file
86
modules/beast_core/text/StringPool.h
Normal file
@@ -0,0 +1,86 @@
|
||||
//------------------------------------------------------------------------------
|
||||
/*
|
||||
This file is part of Beast: https://github.com/vinniefalco/Beast
|
||||
Copyright 2013, Vinnie Falco <vinnie.falco@gmail.com>
|
||||
|
||||
Portions of this file are from JUCE.
|
||||
Copyright (c) 2013 - Raw Material Software Ltd.
|
||||
Please visit http://www.juce.com
|
||||
|
||||
Permission to use, copy, modify, and/or distribute this software for any
|
||||
purpose with or without fee is hereby granted, provided that the above
|
||||
copyright notice and this permission notice appear in all copies.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||
ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
*/
|
||||
//==============================================================================
|
||||
|
||||
#ifndef BEAST_STRINGPOOL_H_INCLUDED
|
||||
#define BEAST_STRINGPOOL_H_INCLUDED
|
||||
|
||||
//==============================================================================
|
||||
/**
|
||||
A StringPool holds a set of shared strings, which reduces storage overheads and improves
|
||||
comparison speed when dealing with many duplicate strings.
|
||||
|
||||
When you add a string to a pool using getPooledString, it'll return a character
|
||||
array containing the same string. This array is owned by the pool, and the same array
|
||||
is returned every time a matching string is asked for. This means that it's trivial to
|
||||
compare two pooled strings for equality, as you can simply compare their pointers. It
|
||||
also cuts down on storage if you're using many copies of the same string.
|
||||
*/
|
||||
class BEAST_API StringPool
|
||||
{
|
||||
public:
|
||||
//==============================================================================
|
||||
/** Creates an empty pool. */
|
||||
StringPool() noexcept;
|
||||
|
||||
/** Destructor */
|
||||
~StringPool();
|
||||
|
||||
//==============================================================================
|
||||
/** Returns a pointer to a copy of the string that is passed in.
|
||||
|
||||
The pool will always return the same pointer when asked for a string that matches it.
|
||||
The pool will own all the pointers that it returns, deleting them when the pool itself
|
||||
is deleted.
|
||||
*/
|
||||
String::CharPointerType getPooledString (const String& original);
|
||||
|
||||
/** Returns a pointer to a copy of the string that is passed in.
|
||||
|
||||
The pool will always return the same pointer when asked for a string that matches it.
|
||||
The pool will own all the pointers that it returns, deleting them when the pool itself
|
||||
is deleted.
|
||||
*/
|
||||
String::CharPointerType getPooledString (const char* original);
|
||||
|
||||
/** Returns a pointer to a copy of the string that is passed in.
|
||||
|
||||
The pool will always return the same pointer when asked for a string that matches it.
|
||||
The pool will own all the pointers that it returns, deleting them when the pool itself
|
||||
is deleted.
|
||||
*/
|
||||
String::CharPointerType getPooledString (const wchar_t* original);
|
||||
|
||||
//==============================================================================
|
||||
/** Returns the number of strings in the pool. */
|
||||
int size() const noexcept;
|
||||
|
||||
/** Returns one of the strings in the pool, by index. */
|
||||
String::CharPointerType operator[] (int index) const noexcept;
|
||||
|
||||
private:
|
||||
Array <String> strings;
|
||||
CriticalSection lock;
|
||||
};
|
||||
|
||||
|
||||
#endif // BEAST_STRINGPOOL_H_INCLUDED
|
||||
Reference in New Issue
Block a user