src/axl/axl_stack.h

   1 /**
   2  *  LibAxl:  Another XML library
   3  *  Copyright (C) 2006 Advanced Software Production Line, S.L.
   4  *
   5  *  This program is free software; you can redistribute it and/or
   6  *  modify it under the terms of the GNU Lesser General Public License
   7  *  as published by the Free Software Foundation; either version 2.1 of
   8  *  the License, or (at your option) any later version.
   9  *
  10  *  This program is distributed in the hope that it will be useful,
  11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  *  GNU Lesser General Public License for more details.
  14  *
  15  *  You should have received a copy of the GNU Lesser General Public
  16  *  License along with this program; if not, write to the Free
  17  *  Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  18  *  02111-1307 USA
  19  *
  20  *  You may find a copy of the license under this software is released
  21  *  at COPYING file. This is LGPL software: you are welcome to
  22  *  develop proprietary applications using this library without any
  23  *  royalty or fee but returning back any change, improvement or
  24  *  addition in the form of source code, project image, documentation
  25  *  patches, etc.
  26  *
  27  *  For commercial support on build XML enabled solutions contact us:
  28  *
  29  *      Postal address:
  30  *         Advanced Software Production Line, S.L.
  31  *         C/ Dr. Michavila Nº 14
  32  *         Coslada 28820 Madrid
  33  *         Spain
  34  *
  35  *      Email address:
  36  *         info@aspl.es - http://fact.aspl.es
  37  */
  38 #ifndef __AXL_STACK_H__
  39 #define __AXL_STACK_H__
  40
  41 #include <axl_decl.h>
  42
  43
  44
  45 BEGIN_C_DECLS
  46
  47 /**
  48  * \addtogroup axl_stack_module
  49  * @{
  50  */
  51
  52 axlStack * axl_stack_new (axlDestroyFunc destroy_data);
  53
  54 void       axl_stack_push (axlStack * stack, axlPointer data);
  55
  56 axlPointer axl_stack_pop  (axlStack * stack);
  57
  58 axlPointer axl_stack_peek (axlStack * stack);
  59
  60 bool       axl_stack_foreach (axlStack         * stack,
  61                               axlStackForeach2   func,
  62                               axlPointer         user_data,
  63                               axlPointer         user_data2);
  64
  65 bool       axl_stack_foreach3 (axlStack         * stack,
  66                                axlStackForeach3   func,
  67                                axlPointer         user_data,
  68                                axlPointer         user_data2,
  69                                axlPointer         user_data3);
  70
  71 int        axl_stack_size (axlStack * stack);
  72
  73 bool       axl_stack_is_empty (axlStack * stack);
  74
  75 void       axl_stack_free (axlStack * stack);
  76
  77 /* @} */
  78
  79 END_C_DECLS
  80
  81 #endif