cleaner.h

/*
 * Copyright regify
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
#ifndef REGIFY_UTIL_CLEANER_H
#define REGIFY_UTIL_CLEANER_H
 
/* Only need to export C interface if used by C++ source code */
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
/*****************************************************************************
*                                                                            *
*  ---------------------- Public Cleaner Interface ------------------------  *
*                                                                            *
*****************************************************************************/
 
typedef rusize_s (*rcWriteFn) (perm_ptr ctx, trans_ptr buf, rusize len);
 
typedef rusize_s (*rcReadFn) (perm_ptr ctx, ptr buf, rusize len);
 
RUAPI ruCleaner ruCleanNew(rusize chunkSize);
 
RUAPI ruCleaner ruCleanFree(ruCleaner rc);
 
typedef void (*ruCleanerCb) (perm_ptr user_data, trans_chars key, trans_chars subst);
 
RUAPI int32_t ruCleanDump(ruCleaner cp, ruCleanerCb lf, perm_ptr user_data);
 
RUAPI int32_t ruCleanAdd(ruCleaner rc, trans_chars instr, trans_chars substitute);
 
RUAPI int32_t ruCleanRemove(ruCleaner rc, trans_chars instr);
 
RUAPI int32_t ruCleanIo(ruCleaner rc, rcReadFn reader, perm_ptr readCtx,
                        rcWriteFn writer, perm_ptr writeCtx);
 
RUAPI int32_t ruCleanToWriter(ruCleaner rc, trans_chars in, rusize len,
                              rcWriteFn writer, perm_ptr writeCtx);
 
#ifndef CLEANER_ONLY
RUAPI int32_t ruCleanToString(ruCleaner rc, trans_chars in, rusize len, ruString *out);
#endif
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif //REGIFY_UTIL_CLEANER_H