cairo/src/cairo-debug.c

   1 /* cairo - a vector graphics library with display and print output
   2  *
   3  * Copyright © 2005 Red Hat, Inc.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it either under the terms of the GNU Lesser General Public
   7  * License version 2.1 as published by the Free Software Foundation
   8  * (the "LGPL") or, at your option, under the terms of the Mozilla
   9  * Public License Version 1.1 (the "MPL"). If you do not alter this
  10  * notice, a recipient may use your version of this file under either
  11  * the MPL or the LGPL.
  12  *
  13  * You should have received a copy of the LGPL along with this library
  14  * in the file COPYING-LGPL-2.1; if not, write to the Free Software
  15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16  * You should have received a copy of the MPL along with this library
  17  * in the file COPYING-MPL-1.1
  18  *
  19  * The contents of this file are subject to the Mozilla Public License
  20  * Version 1.1 (the "License"); you may not use this file except in
  21  * compliance with the License. You may obtain a copy of the License at
  22  * http://www.mozilla.org/MPL/
  23  *
  24  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY
  25  * OF ANY KIND, either express or implied. See the LGPL or the MPL for
  26  * the specific language governing rights and limitations.
  27  *
  28  * The Original Code is the cairo graphics library.
  29  *
  30  * The Initial Developer of the Original Code is Red Hat, Inc.
  31  *
  32  * Contributor(s):
  33  *      Carl D. Worth <cworth@cworth.org>
  34  */
  35
  36 #include "cairoint.h"
  37
  38 /**
  39  * cairo_debug_reset_static_data:
  40  *
  41  * Resets all static data within cairo to its original state,
  42  * (ie. identical to the state at the time of program invocation). For
  43  * example, all caches within cairo will be flushed empty.
  44  *
  45  * This function is intended to be useful when using memory-checking
  46  * tools such as valgrind. When valgrind's memcheck analyzes a
  47  * cairo-using program without a call to cairo_debug_reset_static_data(),
  48  * it will report all data reachable via cairo's static objects as
  49  * "still reachable". Calling cairo_debug_reset_static_data() just prior
  50  * to program termination will make it easier to get squeaky clean
  51  * reports from valgrind.
  52  *
  53  * WARNING: It is only safe to call this function when there are no
  54  * active cairo objects remaining, (ie. the appropriate destroy
  55  * functions have been called as necessary). If there are active cairo
  56  * objects, this call is likely to cause a crash, (eg. an assertion
  57  * failure due to a hash table being destroyed when non-empty).
  58  **/
  59 void
  60 cairo_debug_reset_static_data (void)
  61 {
  62     CAIRO_MUTEX_INITIALIZE ();
  63
  64     _cairo_font_face_reset_static_data ();
  65
  66 #if CAIRO_HAS_FT_FONT
  67     _cairo_ft_font_reset_static_data ();
  68 #endif
  69
  70     _cairo_scaled_font_reset_static_data ();
  71
  72     _cairo_pattern_reset_static_data ();
  73
  74     CAIRO_MUTEX_FINALIZE ();
  75 }