git.maemo.org Git - opencv/blob - interfaces/swig/python/cvswigmacros.i

   1 /*M///////////////////////////////////////////////////////////////////////////////////////
   2 //
   3 //  IMPORTANT: READ BEFORE DOWNLOADING, COPYING, INSTALLING OR USING.
   4 //
   5 //  By downloading, copying, installing or using the software you agree to this license.
   6 //  If you do not agree to this license, do not download, install,
   7 //  copy or use the software.
   8 //
   9 //
  10 //                        Intel License Agreement
  11 //                For Open Source Computer Vision Library
  12 //
  13 // Copyright (C) 2000, Intel Corporation, all rights reserved.
  14 // Third party copyrights are property of their respective owners.
  15 //
  16 // Redistribution and use in source and binary forms, with or without modification,
  17 // are permitted provided that the following conditions are met:
  18 //
  19 //   * Redistribution's of source code must retain the above copyright notice,
  20 //     this list of conditions and the following disclaimer.
  21 //
  22 //   * Redistribution's in binary form must reproduce the above copyright notice,
  23 //     this list of conditions and the following disclaimer in the documentation
  24 //     and/or other materials provided with the distribution.
  25 //
  26 //   * The name of Intel Corporation may not be used to endorse or promote products
  27 //     derived from this software without specific prior written permission.
  28 //
  29 // This software is provided by the copyright holders and contributors "as is" and
  30 // any express or implied warranties, including, but not limited to, the implied
  31 // warranties of merchantability and fitness for a particular purpose are disclaimed.
  32 // In no event shall the Intel Corporation or contributors be liable for any direct,
  33 // indirect, incidental, special, exemplary, or consequential damages
  34 // (including, but not limited to, procurement of substitute goods or services;
  35 // loss of use, data, or profits; or business interruption) however caused
  36 // and on any theory of liability, whether in contract, strict liability,
  37 // or tort (including negligence or otherwise) arising in any way out of
  38 // the use of this software, even if advised of the possibility of such damage.
  39 //
  40 //M*/
  41
  42 /* This file contains swig macros that are used in several typemap files */
  43
  44
  45 %define %myshadow(function)
  46 %ignore function;
  47 %rename (function) function##_Shadow;
  48 %enddef
  49
  50 // Elsewhere in this wrapper, the cvRelease* functions are mapped to
  51 // the destructors for the corresponding OpenCV object wrapper.  This
  52 // is done in order to let Python handle memory management.  If the
  53 // reference count of the Python object wrapping the OpenCV object
  54 // goes to 0, the garbage collector will call the destructor, and
  55 // therefore the cvRelease* function, before freeing the Python object.
  56 // However, if the user explicitly calls the cvRelease* function, we
  57 // must prevent the Python garbage collector from calling it again when
  58 // the refcount reaches 0 -- otherwise a double-free error occurs.
  59 //
  60 // Thus, below, we redirect each cvRelease* function to the
  61 // corresponding OpenCV object's destructor.  This has the effect of:
  62 // (1) Calling the corresponding cvRelease* function, and therefore
  63 //     immediately releasing the OpenCV object.
  64 // (2) Telling SWIG to disown memory management for this OpenCV object.
  65 //
  66 // Thus, when the refcount for the Python object reaches 0, the Python
  67 // object is garbage collected, but since it no longer owns the OpenCV
  68 // object, this is not freed again.
  69 %define %myrelease(module, Function, Type)
  70 %ignore Function;
  71 %rename (Function) Function##_Shadow;
  72 %pythoncode %{
  73 Function = _##module##.delete_##Type
  74 %}
  75 %enddef