qofbookmerge.h

Go to the documentation of this file.

/*********************************************************************
 * qofbookmerge.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        *
 * 51 Franklin Street, Fifth Floor    Fax:    +1-617-542-2652       *
 * Boston, MA  02110-1301,  USA       gnu@gnu.org                   *
 *                                                                   *
 ********************************************************************/

#ifndef QOFBOOKMERGE_H
#define QOFBOOKMERGE_H

#define QOF_MOD_MERGE "qof-merge"

#include "qofutil.h"
#include "qofbook.h"
#include "qofclass.h"
#include "qofobject.h"
#include "qofinstance.h"
#include "qoflog.h"

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

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


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


/* ======================================================================== */
QofBookMergeData *qof_book_merge_init (QofBook * importBook,
                                       QofBook * targetBook);


typedef void (*QofBookMergeRuleForeachCB) (QofBookMergeData *,
                                           QofBookMergeRule *, guint);

void qof_book_merge_rule_foreach (QofBookMergeData * mergeData,
                                  QofBookMergeRuleForeachCB callback,
                                  QofBookMergeResult mergeResult);

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

QofBookMergeData *qof_book_merge_update_result (QofBookMergeData * mergeData,
                                                QofBookMergeResult tag);

gint qof_book_merge_commit (QofBookMergeData * mergeData);

void qof_book_merge_abort (QofBookMergeData * mergeData);

#endif // QOFBOOKMERGE_H

---