apps/plugins/goban/sgf_storage.h

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2007-2009 Joshua Simmons <mud at majidejima dot com>
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; either version 2
  15  * of the License, or (at your option) any later version.
  16  *
  17  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  18  * KIND, either express or implied.
  19  *
  20  ****************************************************************************/
  21
  22 #ifndef GOBAN_SGF_STORAGE_H
  23 #define GOBAN_SGF_STORAGE_H
  24
  25 #include "types.h"
  26
  27 /* Must be called (and return true) before using anything in the SGF
  28    subsystem returns false on failure */
  29 bool setup_sgf (void);
  30
  31 /* Do cleanup, call before exiting the plugin.  You must not use any SGF
  32    subsystem functions after calling this */
  33 void cleanup_sgf (void);
  34
  35 /* Get ready for a new game (either loaded or blank) */
  36 void clear_caches_sgf (void);
  37
  38 /* Clear the SGF tree and get it ready for a new game (loaded or blank) */
  39 void free_tree_sgf (void);
  40
  41 /* Returns true if the Rockbox audio buffer has been stolen */
  42 bool audio_stolen_sgf (void);
  43
  44 /* Returns a handle to a struct storage_t (NOT a pointer) < 0 handles are
  45    invalid */
  46 int alloc_storage_sgf (void);
  47
  48 /* Free one storage location */
  49 void free_storage_sgf (int handle);
  50
  51 /* Get a pointer to a node or property which corresponds to the given
  52  * storage handle
  53  */
  54 struct node_t *get_node (int handle);
  55 struct prop_t *get_prop (int handle);
  56
  57 #endif