mirror of
https://github.com/Gnucash/gnucash.git
synced 2025-02-25 18:55:30 -06:00
945e700a37
in qof and gnc files adding annotation comments to help splint analyze ownership of memory and objects. git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@17983 57a11ea4-9604-0410-9ed3-97b8803252fd
91 lines
3.5 KiB
C
91 lines
3.5 KiB
C
/********************************************************************\
|
|
* SX-book.h -- scheduled transaction dataset access *
|
|
* *
|
|
* This program is free software; you can redistribute it and/or *
|
|
* modify it under the terms of the GNU General Public License as *
|
|
* published by the Free Software Foundation; either version 2 of *
|
|
* the License, or (at your option) any later version. *
|
|
* *
|
|
* This program is distributed in the hope that it will be useful, *
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
|
|
* GNU General Public License for more details. *
|
|
* *
|
|
* You should have received a copy of the GNU General Public License*
|
|
* along with this program; if not, contact: *
|
|
* *
|
|
* Free Software Foundation Voice: +1-617-542-5942 *
|
|
* 51 Franklin Street, Fifth Floor Fax: +1-617-542-2652 *
|
|
* Boston, MA 02110-1301, USA gnu@gnu.org *
|
|
\********************************************************************/
|
|
|
|
/**
|
|
* @addtogroup Engine
|
|
* @{ */
|
|
/**
|
|
* @addtogroup SchedXaction
|
|
* @{ */
|
|
/**
|
|
* @file SX-book.h
|
|
* @brief Anchor Scheduled Transaction info in a book.
|
|
* See src/doc/books.txt for design overview.
|
|
* @author Copyright (c) 2003 Linas Vepstas <linas@linas.org>
|
|
* @author Copyright (c) 2006 Joshua Sled <jsled@asynchronous.org>
|
|
*
|
|
* XXX currently, this is crufty, it should be modified to use
|
|
* entities a bit more whole-heartedly than it does.
|
|
**/
|
|
|
|
#ifndef GNC_SX_BOOK_H
|
|
#define GNC_SX_BOOK_H
|
|
|
|
typedef struct xaccSchedXactionsDef SchedXactions;
|
|
typedef struct _SchedXactionsClass SchedXactionsClass;
|
|
|
|
#include <glib.h>
|
|
#include "SchedXaction.h"
|
|
#include "qof.h"
|
|
|
|
struct xaccSchedXactionsDef {
|
|
QofInstance inst;
|
|
GList* sx_list;
|
|
gboolean sx_notsaved;
|
|
};
|
|
|
|
struct _SchedXactionsClass
|
|
{
|
|
QofInstanceClass parent_class;
|
|
};
|
|
|
|
/* --- type macros --- */
|
|
#define GNC_TYPE_SCHEDXACTIONS (gnc_schedxactions_get_type ())
|
|
#define GNC_SCHEDXACTIONS(o) \
|
|
(G_TYPE_CHECK_INSTANCE_CAST ((o), GNC_TYPE_SCHEDXACTIONS, SchedXactions))
|
|
#define GNC_SCHEDXACTIONS_CLASS(k) \
|
|
(G_TYPE_CHECK_CLASS_CAST((k), GNC_TYPE_SCHEDXACTIONS, SchedXactionsClass))
|
|
#define GNC_IS_SCHEDXACTIONS(o) \
|
|
(G_TYPE_CHECK_INSTANCE_TYPE ((o), GNC_TYPE_SCHEDXACTIONS))
|
|
#define GNC_IS_SCHEDXACTIONS_CLASS(k) \
|
|
(G_TYPE_CHECK_CLASS_TYPE ((k), GNC_TYPE_SCHEDXACTIONS))
|
|
#define GNC_SCHEDXACTIONS_GET_CLASS(o) \
|
|
(G_TYPE_INSTANCE_GET_CLASS ((o), GNC_TYPE_SCHEDXACTIONS, SchedXactionsClass))
|
|
GType gnc_schedxactions_get_type(void);
|
|
|
|
#define GNC_IS_SXES(obj) GNC_IS_SCHEDXACTIONS(obj)
|
|
#define GNC_SXES(obj) GNC_SCHEDXACTIONS(obj)
|
|
|
|
/*@ dependent @*/ SchedXactions* gnc_book_get_schedxactions(QofBook* book);
|
|
|
|
void gnc_sxes_add_sx(SchedXactions* sxes, SchedXaction* sx);
|
|
void gnc_sxes_del_sx(SchedXactions* sxes, SchedXaction* sx);
|
|
|
|
/** Returns the template group from the book. **/
|
|
/*@ dependent @*/ Account *gnc_book_get_template_root(const QofBook *book);
|
|
|
|
/** @return The list of SXes which reference the given Account. Caller should free this list. **/
|
|
GList* gnc_sx_get_sxes_referencing_account(QofBook *book, Account *acct);
|
|
|
|
#endif /* GNC_SX_BOOK_H */
|
|
/** @} */
|
|
/** @} */
|