wordlist.h

   1 /*
   2  * wordlist.h - Routines for manipulating word lists
   3  *
   4  * Jonathan McDowell <noodles@earth.li>
   5  *
   6  * Copyright 2004 Project Purple
   7  */
   8
   9 #ifndef __WORDLIST_H__
  10 #define __WORDLIST_H__
  11
  12 #include "ll.h"
  13 #include "keystructs.h"
  14
  15 /**
  16  *      makewordlist - Takes a string and splits it into a set of unique words.
  17  *      @wordlist: The current word list.
  18  *      @words: The string to split and add.
  19  *
  20  *      We take words and split it on non alpha numeric characters. These get
  21  *      added to the word list if they're not already present. If the wordlist
  22  *      is NULL then we start a new list, otherwise it's search for already
  23  *      added words. Note that words is modified in the process of scanning.
  24  *
  25  *      Returns the new word list.
  26  */
  27 struct ll *makewordlist(struct ll *wordlist, char *word);
  28
  29 /**
  30  *      makewordlistfromkey - Takes a public key and splits it into a set of
  31  *                     unique words.
  32  *      @wordlist: The current word list.
  33  *      @key: The key to return the words from.
  34  *
  35  *      We take words and split it on non alpha numeric characters. These get
  36  *      added to the word list if they're not already present. If the wordlist
  37  *      is NULL then we start a new list, otherwise it's search for already
  38  *      added words. Note that words is modified in the process of scanning.
  39  *
  40  *      Returns the new word list.
  41  */
  42 struct ll *makewordlistfromkey(struct ll *wordlist,
  43                                struct openpgp_publickey *key);
  44
  45 #endif /* __WORDLIST_H__ */