wordlist.h

   1 /*
   2  * wordlist.h - Routines for manipulating word lists
   3  *
   4  * Copyright 2004 Jonathan McDowell <noodles@earth.li>
   5  *
   6  * This program is free software: you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the Free
   8  * Software Foundation; version 2 of the License.
   9  *
  10  * This program is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  13  * more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along with
  16  * this program.  If not, see <https://www.gnu.org/licenses/>.
  17  */
  18
  19 #ifndef __WORDLIST_H__
  20 #define __WORDLIST_H__
  21
  22 #include "ll.h"
  23 #include "keystructs.h"
  24
  25 /**
  26  *      makewordlist - Takes a string and splits it into a set of unique words.
  27  *      @wordlist: The current word list.
  28  *      @words: The string to split and add.
  29  *
  30  *      We take words and split it on non alpha numeric characters. These get
  31  *      added to the word list if they're not already present. If the wordlist
  32  *      is NULL then we start a new list, otherwise it's search for already
  33  *      added words. Note that words is modified in the process of scanning.
  34  *
  35  *      Returns the new word list.
  36  */
  37 struct ll *makewordlist(struct ll *wordlist, char *word);
  38
  39 /**
  40  *      makewordlistfromkey - Takes a public key and splits it into a set of
  41  *                     unique words.
  42  *      @wordlist: The current word list.
  43  *      @key: The key to return the words from.
  44  *
  45  *      We take words and split it on non alpha numeric characters. These get
  46  *      added to the word list if they're not already present. If the wordlist
  47  *      is NULL then we start a new list, otherwise it's search for already
  48  *      added words. Note that words is modified in the process of scanning.
  49  *
  50  *      Returns the new word list.
  51  */
  52 struct ll *makewordlistfromkey(struct ll *wordlist,
  53                                struct openpgp_publickey *key);
  54
  55 #endif /* __WORDLIST_H__ */