/* This is -*- C -*- */
/* vim: set sw=2: */
/* $Id$ */

/*
 * wordbag.h
 *
 * Copyright (C) 2003 The Free Software Foundation, Inc.
 *
 * Developed by Jon Trowbridge <trow@gnu.org>
 */

/*
 * 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA.
 */

#ifndef __WORDBAG_H__
#define __WORDBAG_H__

#include <glib.h>
#include <Python.h>

#include "dictionary.h"

typedef struct _WordBag WordBag;
struct _WordBag {
  int refs;

  int total_size;
  GPtrArray **by_syl;
};

WordBag *word_bag_new   (void);
WordBag *word_bag_ref   (WordBag *);
void     word_bag_unref (WordBag *);

void     word_bag_add  (WordBag *bag, DictionaryWord *word);

int      word_bag_size              (WordBag *bag);

int      word_bag_size_by_syllables (WordBag *bag,
				     int min_syl, int max_syl);

DictionaryWord *word_bag_pick_by_syllables (WordBag *bag,
					    int min_syl, int max_syl);

DictionaryWord *word_bag_pick_by_meter (WordBag *bag,
					int min_syl, int max_syl,
					const Meter *meter,
					gboolean left_match);


/* Python Extensions */

PyObject *word_bag_to_py   (WordBag *);
WordBag  *word_bag_from_py (PyObject *py_bag);

PyObject *py_word_bag_new (PyObject *self, PyObject *args);



#endif /* __WORDBAG_H__ */