qof_book_merge.h

Go to the documentation of this file.

/*********************************************************************
 * qof_book_merge.h -- api for QofBook merge with collision handling *
 * Copyright (C) 2004 Neil Williams <linux@codehelp.co.uk>           *
 *                                                                   *
 * 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        *
 * 59 Temple Place - Suite 330        Fax:    +1-617-542-2652        *
 * Boston, MA  02111-1307,  USA       gnu@gnu.org                    *
 *                                                                   *
 ********************************************************************/

#ifndef QOFBOOKMERGE_H
#define QOFBOOKMERGE_H

#ifndef _GNU_SOURCE
#define _GNU_SOURCE
#endif
#define QOF_MOD_MERGE "qof-merge"

#include <glib.h>
#include "gnc-engine-util.h"
#include "qofbook.h"
#include "qofclass.h"
#include "qofobject.h"
#include "qofinstance.h"
#include "gnc-trace.h"

typedef enum { 
        MERGE_UNDEF,            
        MERGE_ABSOLUTE,         
        MERGE_NEW,       
        MERGE_REPORT,           
        MERGE_DUPLICATE, 
        MERGE_UPDATE,    
        MERGE_INVALID    
}qof_book_mergeResult;

typedef struct 
{
        /* internal counters and reference variables */
        gboolean mergeAbsolute;                 
        double difference;                              
        gboolean updated;                               
        /* rule objects set from or by external calls */
        QofIdType mergeType;                    
        const char* mergeLabel;                 
        GSList *mergeParam;                             
        GSList *linkedEntList;                  
        qof_book_mergeResult mergeResult; 
        QofEntity *importEnt;                   
        QofEntity *targetEnt;                   
}qof_book_mergeRule;


typedef struct
{
        GSList  *mergeObjectParams;     
        GList   *mergeList;                     
        GSList  *targetList;            
        QofBook *mergeBook;                     
        QofBook *targetBook;            
        gboolean abort;                         
        qof_book_mergeRule *currentRule; 
        GSList *orphan_list;                    
        GHashTable *target_table;       
}qof_book_mergeData;


/* ======================================================================== */
qof_book_mergeData*
qof_book_mergeInit( QofBook *importBook, QofBook *targetBook);


typedef void (* qof_book_mergeRuleForeachCB)( qof_book_mergeData*, qof_book_mergeRule*, guint);

void qof_book_mergeRuleForeach( qof_book_mergeData* mergeData,
                                qof_book_mergeRuleForeachCB callback , 
                                qof_book_mergeResult mergeResult);

char* qof_book_merge_param_as_string(QofParam *qtparam, QofEntity *qtEnt);

qof_book_mergeData*
qof_book_mergeUpdateResult(qof_book_mergeData *mergeData, qof_book_mergeResult tag);


int
qof_book_mergeCommit( qof_book_mergeData *mergeData );

void
qof_book_merge_abort(qof_book_mergeData *mergeData);

#endif // QOFBOOKMERGE_H

---