ffword.h

Go to the documentation of this file.

/*
 * finflect - Algorithms and tools for inflecting Finnish nouns
 * Copyright (C) 2004, 2005  The FinFlect Team
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 * 
 * 
 * For the complete legal text of the GNU Lesser General Public License,
 * see the file LICENSE. For a complete list of authors and copyright
 * holders, see the file AUTHORS.
 */

/**
 * @file ffword.h Declares the ffword data type (a string with metadata)
 * and some functions to manipulate its instances. They are implemented in ffword.c.
 */
 
#ifndef __FFWORD_H
#define __FFWORD_H

#ifdef __cplusplus
extern "C" {
#endif

#include "fftypes.h"
#include "ffstring.h"
#include "ffops.h"

/**
 * Bundles together a word and its metadata.
 */
typedef struct ffword {
  /**
   * The string data
   */
  ffstring data;
  
  /**
   * The metadata
   */
  ffops metadata;
} ffword;

/**
 * Create an ffword from a C style string.
 * @param source The source C-style string
 * @param target The target user-allocated ffword
 * @return 0 on success; negative on error
 */
ffint32 ffword_create(const ffchar* source, ffword* target);

/**
 * Create a copy of an ffword.
 * @param source The source ffword
 * @param target The target ffword
 * @return 0 on success; negative on error
 */
ffint32 ffword_copy(ffword* source, ffword* target);

/**
 * Deletes an ffword. Only deletes the string data of the word at the moment,
 * but might do something creative in the future.
 * @param target The ffword to delete
 * @return 0 on success; negative on error
 */
ffint32 ffword_delete(ffword* target);

/**
 * Replaces the data of target with the data of source and then deletes the source. Metadata is not replaced.
 * @param source The ffword to move
 * @param target The ffword to move to
 * @return 0 on success; negative on error
 */
ffint32 ffword_move(ffword* source, ffword* target);

/**
 * Delete an ffword without deallocating the real string data of the str member.
 * After finalizing the only usable member of an ffword is the data string.
 * ffwords do not need to be deleted after finalizing. Finalizing only decreases
 * the ffstring instance counter at the moment, but might do something
 * creative in the future.
 * @param target The ffword to finalize
 * @return 0 on success; negative on error
 */
ffint32 ffword_finalize(ffword* target);

ffint32 ffword_swap_delete(ffword* source, ffword* target);

#ifdef __cplusplus
}
#endif

#endif

---