ffutil.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 ffutil.h Declares some necessary utility functions (implemented in ffutil.c).
 */

#ifndef __FFUTIL_H
#define __FFUTIL_H

#ifdef __cplusplus
extern "C" {
#endif

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

/**
 * Determines whether the given letter is a (Finnish) vowel or not.
 * @param letter The letter to check
 * @return 1 if the letter is a vowel, 0 if it's not.
 */
ffbool ffpriv_is_vowel(const char letter);

/**
 * Determines whether the given letter is a (Finnish) consonant or not.
 * @param letter The letter to check
 * @return 1 if the letter is a vowel, 0 if it's not.
 */
ffbool ffpriv_is_consonant(const char letter);

/**
 * Returns the appropriate one, back or front, depending on whether the given string has back or front vowels.
 */
ffchar* ffpriv_vowel_harmony(const ffstring* string, ffchar* back, ffchar* front);

#ifdef __cplusplus
}
#endif

#endif

---