Feature cleanup

RefactoringNotes.txt

@@ -1,4 +1,27 @@
 --------------------------------------------------------------------------------
+TODO
+--------------------------------------------------------------------------------
+
+- Document in order:
+    SerializedType
+    STObject
+    SerializedLedgerEntry
+
+- Replace uint160, uint256 in argument lists, template parameter lists, and
+  data members with tyepdefs from ripple_ProtocolTypes.h
+
+--------------------------------------------------------------------------------
+
+LoadEvent
+
+    Is referenced with both a shared pointer and an auto pointer.
+
+JobQueue
+
+    getLoadEvent and getLoadEventAP differ only in the style of pointer
+    container which is returned. Unnecessary complexity.
+
+--------------------------------------------------------------------------------
 
 Naming
 
@@ -24,7 +47,7 @@ Verbose names
 
 Ledger "Skip List"
 
-  Is not really a skip list
+  Is not really a skip list data structure
 
 --------------------------------------------------------------------------------
 
@@ -42,10 +65,29 @@ Interfaces
     would be more clear:
         bool write (OutputStream& stream);
 
-
+--------------------------------------------------------------------------------
 
 Implementation
 
   LoadManager
 
     What is going on in the destructor
+
+--------------------------------------------------------------------------------
+
+boost
+
+    Unclear from the class declaration what style of shared object management
+    is used. Prefer to derive from a ReferenceCountedObject class so that the
+    behavior is explicit. Furthermore the use of intrusive containers is
+    preferred over the alternative.
+
+    make_shared <> () is awkward.
+
+boost::recursive_mutex
+
+    Recursive mutexes should never be necessary.
+    They require the "mutable" keyword for const members to acquire the lock (yuck)
+
+    Replace recursive_mutex with juce::Mutex to remove boost dependency
+

modules/ripple_basics/containers/ripple_KeyCache.h

@@ -1,5 +1,8 @@
-
 //------------------------------------------------------------------------------
+/*
+    Copyright (c) 2011-2013, OpenCoin, Inc.
+*/
+//==============================================================================
 
 #ifndef RIPPLE_KEYCACHE_H
 #define RIPPLE_KEYCACHE_H

modules/ripple_basics/containers/ripple_RangeSet.cpp

@@ -1,3 +1,8 @@
+//------------------------------------------------------------------------------
+/*
+    Copyright (c) 2011-2013, OpenCoin, Inc.
+*/
+//==============================================================================
 
 SETUP_LOG (RangeSet)
 

modules/ripple_basics/containers/ripple_RangeSet.h

@@ -1,6 +1,15 @@
+//------------------------------------------------------------------------------
+/*
+    Copyright (c) 2011-2013, OpenCoin, Inc.
+*/
+//==============================================================================
+
 #ifndef RIPPLE_RANGESET_H
 #define RIPPLE_RANGESET_H
 
+/** A sparse set of integers.
+*/
+// VFALCO TODO Replace with juce::SparseSet
 class RangeSet
 {
 public:

modules/ripple_basics/containers/ripple_SecureAllocator.h

@@ -1,3 +1,8 @@
+//------------------------------------------------------------------------------
+/*
+    Copyright (c) 2011-2013, OpenCoin, Inc.
+*/
+//==============================================================================
 
 #ifndef RIPPLE_SECUREALLOCATOR_H
 #define RIPPLE_SECUREALLOCATOR_H

modules/ripple_basics/containers/ripple_TaggedCache.cpp

@@ -1 +1,7 @@
+//------------------------------------------------------------------------------
+/*
+    Copyright (c) 2011-2013, OpenCoin, Inc.
+*/
+//==============================================================================
+
 SETUP_LOG (TaggedCacheLog)

modules/ripple_basics/containers/ripple_TaggedCache.h

@@ -1,3 +1,9 @@
+//------------------------------------------------------------------------------
+/*
+    Copyright (c) 2011-2013, OpenCoin, Inc.
+*/
+//==============================================================================
+
 #ifndef RIPPLE_TAGGEDCACHE_H
 #define RIPPLE_TAGGEDCACHE_H
 

modules/ripple_basics/ripple_basics.cpp

@@ -1,18 +1,6 @@
 //------------------------------------------------------------------------------
 /*
     Copyright (c) 2011-2013, OpenCoin, Inc.
-
-    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.
 */
 //==============================================================================
 

modules/ripple_basics/ripple_basics.h

@@ -1,18 +1,6 @@
 //------------------------------------------------------------------------------
 /*
     Copyright (c) 2011-2013, OpenCoin, Inc.
-
-    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.
 */
 //==============================================================================
 

modules/ripple_basics/types/ripple_BasicTypes.h

@@ -1,5 +1,8 @@
-
 //------------------------------------------------------------------------------
+/*
+    Copyright (c) 2011-2013, OpenCoin, Inc.
+*/
+//==============================================================================
 
 #ifndef RIPPLE_TYPES_H
 #define RIPPLE_TYPES_H

modules/ripple_basics/types/ripple_HashMaps.h

@@ -1,5 +1,8 @@
-
 //------------------------------------------------------------------------------
+/*
+    Copyright (c) 2011-2013, OpenCoin, Inc.
+*/
+//==============================================================================
 
 #ifndef RIPPLE_HASHMAPS_H
 #define RIPPLE_HASHMAPS_H

modules/ripple_basics/types/ripple_UInt256.cpp

@@ -1,3 +1,8 @@
+//------------------------------------------------------------------------------
+/*
+    Copyright (c) 2011-2013, OpenCoin, Inc.
+*/
+//==============================================================================
 
 std::size_t hash_value (uint256 const& u)
 {

modules/ripple_basics/types/ripple_UInt256.h

@@ -1,3 +1,9 @@
+//------------------------------------------------------------------------------
+/*
+    Copyright (c) 2011-2013, OpenCoin, Inc.
+*/
+//==============================================================================
+
 // Copyright (c) 2009-2010 Satoshi Nakamoto
 // Copyright (c) 2011 The Bitcoin developers
 // Distributed under the MIT/X11 software license, see the accompanying

modules/ripple_basics/utility/ripple_ByteOrder.cpp

@@ -1,3 +1,9 @@
+//------------------------------------------------------------------------------
+/*
+    Copyright (c) 2011-2013, OpenCoin, Inc.
+*/
+//==============================================================================
+
 #ifdef WIN32
 
 //#include <windows.h>

modules/ripple_basics/utility/ripple_ByteOrder.h

@@ -1,3 +1,9 @@
+//------------------------------------------------------------------------------
+/*
+    Copyright (c) 2011-2013, OpenCoin, Inc.
+*/
+//==============================================================================
+
 #ifndef RIPPLE_BYTEORDER_H
 #define RIPPLE_BYTEORDER_H
 

modules/ripple_basics/utility/ripple_DiffieHellmanUtil.cpp

@@ -1,4 +1,8 @@
-
+//------------------------------------------------------------------------------
+/*
+    Copyright (c) 2011-2013, OpenCoin, Inc.
+*/
+//==============================================================================
 
 std::string DH_der_gen (int iKeyLength)
 {

modules/ripple_basics/utility/ripple_DiffieHellmanUtil.h

@@ -1,4 +1,8 @@
-
+//------------------------------------------------------------------------------
+/*
+    Copyright (c) 2011-2013, OpenCoin, Inc.
+*/
+//==============================================================================
 
 #ifndef RIPPLE_DIFFIEHELLMANUTIL_H
 #define RIPPLE_DIFFIEHELLMANUTIL_H

modules/ripple_basics/utility/ripple_HashUtilities.h

@@ -1,3 +1,9 @@
+//------------------------------------------------------------------------------
+/*
+    Copyright (c) 2011-2013, OpenCoin, Inc.
+*/
+//==============================================================================
+
 #ifndef RIPPLE_HASHUTILITIES_H
 #define RIPPLE_HASHUTILITIES_H
 

modules/ripple_basics/utility/ripple_InstanceCounter.cpp

@@ -1,3 +1,8 @@
+//------------------------------------------------------------------------------
+/*
+    Copyright (c) 2011-2013, OpenCoin, Inc.
+*/
+//==============================================================================
 
 InstanceType* InstanceType::sHeadInstance = NULL;
 bool InstanceType::sMultiThreaded = false;

modules/ripple_basics/utility/ripple_InstanceCounter.h

@@ -1,3 +1,9 @@
+//------------------------------------------------------------------------------
+/*
+    Copyright (c) 2011-2013, OpenCoin, Inc.
+*/
+//==============================================================================
+
 #ifndef RIPPLE_INSTANCECOUNTER_H
 #define RIPPLE_INSTANCECOUNTER_H
 

modules/ripple_basics/utility/ripple_IntegerTypes.h

@@ -1,5 +1,11 @@
-#ifndef INTEGERTYPES_H
-#define INTEGERTYPES_H
+//------------------------------------------------------------------------------
+/*
+    Copyright (c) 2011-2013, OpenCoin, Inc.
+*/
+//==============================================================================
+
+#ifndef RIPPLE_INTEGERTYPES_H
+#define RIPPLE_INTEGERTYPES_H
 
 // VFALCO TODO determine if Borland C is supported
 #if defined (_MSC_VER) /*|| defined(__BORLANDC__)*/

modules/ripple_basics/utility/ripple_Log.cpp

@@ -1,3 +1,8 @@
+//------------------------------------------------------------------------------
+/*
+    Copyright (c) 2011-2013, OpenCoin, Inc.
+*/
+//==============================================================================
 
 boost::recursive_mutex Log::sLock;
 

modules/ripple_basics/utility/ripple_Log.h

@@ -1,3 +1,9 @@
+//------------------------------------------------------------------------------
+/*
+    Copyright (c) 2011-2013, OpenCoin, Inc.
+*/
+//==============================================================================
+
 #ifndef RIPPLE_LOG_H
 #define RIPPLE_LOG_H
 

modules/ripple_basics/utility/ripple_PlatformMacros.h

@@ -1,18 +1,6 @@
 //------------------------------------------------------------------------------
 /*
     Copyright (c) 2011-2013, OpenCoin, Inc.
-
-    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.
 */
 //==============================================================================
 

modules/ripple_basics/utility/ripple_RandomNumbers.cpp

@@ -1,18 +1,6 @@
 //------------------------------------------------------------------------------
 /*
     Copyright (c) 2011-2013, OpenCoin, Inc.
-
-    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.
 */
 //==============================================================================
 

modules/ripple_basics/utility/ripple_RandomNumbers.h

@@ -1,18 +1,6 @@
 //------------------------------------------------------------------------------
 /*
     Copyright (c) 2011-2013, OpenCoin, Inc.
-
-    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.
 */
 //==============================================================================
 

modules/ripple_basics/utility/ripple_ScopedLock.h

@@ -1,3 +1,9 @@
+//------------------------------------------------------------------------------
+/*
+    Copyright (c) 2011-2013, OpenCoin, Inc.
+*/
+//==============================================================================
+
 #ifndef RIPPLE_SCOPEDLOCK_H
 #define RIPPLE_SCOPEDLOCK_H
 

modules/ripple_basics/utility/ripple_StringUtilities.cpp

@@ -1,3 +1,8 @@
+//------------------------------------------------------------------------------
+/*
+    Copyright (c) 2011-2013, OpenCoin, Inc.
+*/
+//==============================================================================
 
 #if !defined(WIN32) && !defined(WIN64)
 #define _vsnprintf(a,b,c,d) vsnprintf(a,b,c,d)

modules/ripple_basics/utility/ripple_StringUtilities.h

@@ -1,3 +1,9 @@
+//------------------------------------------------------------------------------
+/*
+    Copyright (c) 2011-2013, OpenCoin, Inc.
+*/
+//==============================================================================
+
 #ifndef RIPPLE_STRINGUTILITIES_H
 #define RIPPLE_STRINGUTILITIES_H