/*

  Copyright (c) 2009-2011 Samuel Lidén Borell <samuel@kodafritt.se>
 
  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 PLATFORM_H
#define PLATFORM_H

#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include "backend.h"

/* Initialization */
void platform_init(int *argc, char ***argv);

/* Pipe I/O */
typedef void (PlatformPipeFunction) (void);
void platform_setupPipe(PlatformPipeFunction *pipeFunction);

/* File IO */
typedef enum { Platform_OpenRead, Platform_OpenCreate } PlatformOpenMode;
FILE *platform_openLocked(const char *filename, PlatformOpenMode mode);
bool platform_closeLocked(FILE *file);
bool platform_deleteLocked(FILE *file, const char *filename);
bool platform_readFile(const char *filename, char **data, int *length);

typedef struct PlatformDirIter PlatformDirIter;
PlatformDirIter *platform_openDir(const char *pathname);
bool platform_iterateDir(PlatformDirIter *iter);
char *platform_currentName(PlatformDirIter *iter);
char *platform_currentPath(PlatformDirIter *iter);
void platform_closeDir(PlatformDirIter *iter);

void platform_keyDirs(char*** path, size_t* len);
PlatformDirIter *platform_openKeysDir(char *path);
char *platform_filterFilename(const char *filename);
char *platform_getFilenameForKey(const char *nameAttr);
char *platform_getDumpFilename(const char *prefix, const char *suffix);

/* Configuration */
char *platform_getConfigPath(const char *appname);

typedef struct PlatformConfig PlatformConfig;
PlatformConfig *platform_openConfig(const char *appname,
                                    const char *configname);
bool platform_saveConfig(PlatformConfig *config);
void platform_freeConfig(PlatformConfig *config);

#define PLATFORM_CFGPARAMS PlatformConfig *config, \
                           const char *section, const char *name
bool platform_getConfigInteger(const PLATFORM_CFGPARAMS, long *value);
bool platform_getConfigBool(const PLATFORM_CFGPARAMS, bool *value);
bool platform_getConfigString(const PLATFORM_CFGPARAMS, char **value);

void platform_setConfigInteger(PLATFORM_CFGPARAMS, long value);
void platform_setConfigBool(PLATFORM_CFGPARAMS, bool value);
void platform_setConfigString(PLATFORM_CFGPARAMS, const char *value);

/* User interface */

// This value has to match the value in the window system
// (for example, None on X11)
#define PLATFORM_NO_WINDOW 0

void platform_mainloop(void);
void platform_leaveMainloop(void);

/* Signature dialog */
void platform_startSign(const char *url, const char *hostname, const char *ip,
                        unsigned long parentWindowId);
void platform_endSign(void);
void platform_setNotifier(BackendNotifier *notifier);
void platform_setMessage(const char *message);
void platform_focusPassword();
void platform_addKeyDirectories(void);
void platform_addToken(Token *token);
void platform_removeToken(Token *token);
bool platform_sign(Token **token, char *password, int password_maxlen);

/* Password selection (and key generation) dialog */
void platform_startChoosePassword(const char *name, unsigned long parentWindowId);
void platform_setPasswordPolicy(int minLength, int minNonDigits, int minDigits);
void platform_endChoosePassword(void);
bool platform_choosePassword(char *password, long password_maxlen);

/* Errors */
void platform_showError(TokenError error);

#endif