include/am-moveable.h
author David Anderson <danderson@mozilla.com>
Tue Aug 27 00:55:44 2013 -0700 (2013-08-27)
changeset 13 ef6b69693bab
parent 11 cfe800908837
permissions -rw-r--r--
Added missing hashmap tests.
     1 // vim: set sts=8 ts=2 sw=2 tw=99 et:
     2 //
     3 // Copyright (C) 2013, David Anderson and AlliedModders LLC
     4 // All rights reserved.
     5 // 
     6 // Redistribution and use in source and binary forms, with or without
     7 // modification, are permitted provided that the following conditions are met:
     8 // 
     9 //  * Redistributions of source code must retain the above copyright notice, this
    10 //    list of conditions and the following disclaimer.
    11 //  * Redistributions in binary form must reproduce the above copyright notice,
    12 //    this list of conditions and the following disclaimer in the documentation
    13 //    and/or other materials provided with the distribution.
    14 //  * Neither the name of AlliedModders LLC nor the names of its contributors
    15 //    may be used to endorse or promote products derived from this software
    16 //    without specific prior written permission.
    17 //
    18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    21 // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
    22 // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    23 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    24 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    25 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    26 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    27 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    28 // POSSIBILITY OF SUCH DAMAGE.
    29 
    30 #ifndef _include_amtl_moveable_h_
    31 #define _include_amtl_moveable_h_
    32 
    33 namespace ke {
    34 
    35 // This is a feature in C++11, but since AM projects do not have access to
    36 // C++11 yet, we provide templates to implement move semantics. A class can
    37 // provide a constructor for (ke::Moveable<T> t) which containers will try
    38 // to use.
    39 //
    40 // When implementing a constructor that takes a Moveable, the object being
    41 // moved should be left in a state that is safe, since its destructor will
    42 // be called even though it has been moved.
    43 
    44 template <typename T>
    45 struct Moveable
    46 {
    47  public:
    48   explicit Moveable(T &t)
    49    : t_(t)
    50   {
    51   }
    52 
    53   T *operator ->() {
    54     return &t_;
    55   }
    56   operator T &() {
    57     return t_;
    58   }
    59 
    60  private:
    61   T &t_;
    62 };
    63 
    64 template <typename T>
    65 static inline Moveable<T>
    66 Move(T &t)
    67 {
    68   return Moveable<T>(t);
    69 }
    70 
    71 } // namespace ke
    72 
    73 #endif // _include_amtl_moveable_h_