mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-30 07:55:51 +00:00
Reduce Beast public interface and eliminate unused code:
Beast includes a lot of code for encapsulating cross-platform differences which are not used or needed by rippled. Additionally, a lot of that code implements functionality that is available from the standard library. This moves away from custom implementations of features that the standard library provides and reduces the number of platform-specific interfaces andfeatures that Beast makes available. Highlights include: * Use std:: instead of beast implementations when possible * Reduce the use of beast::String in public interfaces * Remove Windows-specific COM and Registry code * Reduce the public interface of beast::File * Reduce the public interface of beast::SystemStats * Remove unused sysctl/getsysinfo functions * Remove beast::Logger
This commit is contained in:
Nik Bougalis
committed by
Vinnie Falco
Vinnie Falco
parent
fefdb32d08
commit
186ca9c235
@@ -1,85 +0,0 @@
|
||||
//------------------------------------------------------------------------------
|
||||
/*
|
||||
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_DYNAMICLIBRARY_H_INCLUDED
|
||||
#define BEAST_DYNAMICLIBRARY_H_INCLUDED
|
||||
|
||||
namespace beast
|
||||
{
|
||||
|
||||
/**
|
||||
Handles the opening and closing of DLLs.
|
||||
|
||||
This class can be used to open a DLL and get some function pointers from it.
|
||||
Since the DLL is freed when this object is deleted, it's handy for managing
|
||||
library lifetimes using RAII.
|
||||
*/
|
||||
class DynamicLibrary : LeakChecked <DynamicLibrary>
|
||||
{
|
||||
public:
|
||||
/** Creates an unopened DynamicLibrary object.
|
||||
Call open() to actually open one.
|
||||
*/
|
||||
DynamicLibrary() noexcept : handle (nullptr) {}
|
||||
|
||||
/**
|
||||
*/
|
||||
DynamicLibrary (const String& name) : handle (nullptr) { open (name); }
|
||||
|
||||
DynamicLibrary (DynamicLibrary const&) = delete;
|
||||
DynamicLibrary& operator= (DynamicLibrary const&) = delete;
|
||||
|
||||
/** Destructor.
|
||||
If a library is currently open, it will be closed when this object is destroyed.
|
||||
*/
|
||||
~DynamicLibrary() { close(); }
|
||||
|
||||
/** Opens a DLL.
|
||||
The name and the method by which it gets found is of course platform-specific, and
|
||||
may or may not include a path, depending on the OS.
|
||||
If a library is already open when this method is called, it will first close the library
|
||||
before attempting to load the new one.
|
||||
@returns true if the library was successfully found and opened.
|
||||
*/
|
||||
bool open (const String& name);
|
||||
|
||||
/** Releases the currently-open DLL, or has no effect if none was open. */
|
||||
void close();
|
||||
|
||||
/** Tries to find a named function in the currently-open DLL, and returns a pointer to it.
|
||||
If no library is open, or if the function isn't found, this will return a null pointer.
|
||||
*/
|
||||
void* getFunction (const String& functionName) noexcept;
|
||||
|
||||
/** Returns the platform-specific native library handle.
|
||||
You'll need to cast this to whatever is appropriate for the OS that's in use.
|
||||
*/
|
||||
void* getNativeHandle() const noexcept { return handle; }
|
||||
|
||||
private:
|
||||
void* handle;
|
||||
};
|
||||
|
||||
} // beast
|
||||
|
||||
#endif // BEAST_DYNAMICLIBRARY_H_INCLUDED
|
||||
@@ -36,22 +36,6 @@ namespace beast {
|
||||
*/
|
||||
namespace Process
|
||||
{
|
||||
//==============================================================================
|
||||
enum ProcessPriority
|
||||
{
|
||||
LowPriority = 0,
|
||||
NormalPriority = 1,
|
||||
HighPriority = 2,
|
||||
RealtimePriority = 3
|
||||
};
|
||||
|
||||
/** Changes the current process's priority.
|
||||
|
||||
@param priority the process priority, where
|
||||
0=low, 1=normal, 2=high, 3=realtime
|
||||
*/
|
||||
void setPriority (const ProcessPriority priority);
|
||||
|
||||
/** Kills the current process immediately.
|
||||
|
||||
This is an emergency process terminator that kills the application
|
||||
@@ -63,70 +47,8 @@ namespace Process
|
||||
void terminate();
|
||||
|
||||
//==============================================================================
|
||||
/** Returns true if this application process is the one that the user is
|
||||
currently using.
|
||||
*/
|
||||
bool isForegroundProcess();
|
||||
|
||||
/** Attempts to make the current process the active one.
|
||||
(This is not possible on some platforms).
|
||||
*/
|
||||
void makeForegroundProcess();
|
||||
|
||||
//==============================================================================
|
||||
/** Raises the current process's privilege level.
|
||||
|
||||
Does nothing if this isn't supported by the current OS, or if process
|
||||
privilege level is fixed.
|
||||
*/
|
||||
void raisePrivilege();
|
||||
|
||||
/** Lowers the current process's privilege level.
|
||||
|
||||
Does nothing if this isn't supported by the current OS, or if process
|
||||
privilege level is fixed.
|
||||
*/
|
||||
void lowerPrivilege();
|
||||
|
||||
/** Returns true if this process is being hosted by a debugger. */
|
||||
bool isRunningUnderDebugger();
|
||||
|
||||
//==============================================================================
|
||||
/** Tries to launch the OS's default reader application for a given file or URL. */
|
||||
bool openDocument (const String& documentURL, const String& parameters);
|
||||
|
||||
#if BEAST_WINDOWS || DOXYGEN
|
||||
//==============================================================================
|
||||
/** WINDOWS ONLY - This returns the HINSTANCE of the current module.
|
||||
|
||||
The return type is a void* to avoid being dependent on windows.h - just cast
|
||||
it to a HINSTANCE to use it.
|
||||
|
||||
In a normal BEAST application, this will be automatically set to the module
|
||||
handle of the executable.
|
||||
|
||||
If you've built a DLL and plan to use any BEAST messaging or windowing classes,
|
||||
you'll need to make sure you call the setCurrentModuleInstanceHandle()
|
||||
to provide the correct module handle in your DllMain() function, because
|
||||
the system relies on the correct instance handle when opening windows.
|
||||
*/
|
||||
void* getCurrentModuleInstanceHandle() noexcept;
|
||||
|
||||
/** WINDOWS ONLY - Sets a new module handle to be used by the library.
|
||||
|
||||
The parameter type is a void* to avoid being dependent on windows.h, but it actually
|
||||
expects a HINSTANCE value.
|
||||
|
||||
@see getCurrentModuleInstanceHandle()
|
||||
*/
|
||||
void setCurrentModuleInstanceHandle (void* newHandle) noexcept;
|
||||
#endif
|
||||
|
||||
#if BEAST_MAC || DOXYGEN
|
||||
//==============================================================================
|
||||
/** OSX ONLY - Shows or hides the OSX dock icon for this app. */
|
||||
void setDockIconVisible (bool isVisible);
|
||||
#endif
|
||||
};
|
||||
|
||||
} // beast
|
||||
|
||||
Reference in New Issue
Block a user