setupgui/setupgui.h

// Copyright (c) 2007, 2024, Oracle and/or its affiliates.
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License, version 2.0, as
// published by the Free Software Foundation.
//
// This program is designed to work with certain software (including
// but not limited to OpenSSL) that is licensed under separate terms, as
// designated in a particular file or component or in included license
// documentation. The authors of MySQL hereby grant you an additional
// permission to link the program and your derivative works with the
// separately licensed software that they have either included with
// the program or referenced in the documentation.
//
// Without limiting anything contained in the foregoing, this file,
// which is part of Connector/ODBC, is also subject to the
// Universal FOSS Exception, version 1.0, a copy of which can be found at
// https://oss.oracle.com/licenses/universal-foss-exception.
//
// This program 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 General Public License, version 2.0, for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

#ifndef _SETUPGUI_H
#define _SETUPGUI_H

#ifdef _WIN32
# include <winsock2.h>
# include <windows.h>

#define CONNECTION_TAB  1
#define AUTH_TAB        2
#define METADATA_TAB    3
#define CURSORS_TAB     4
#define DEBUG_TAB       5
#define SSL_TAB         6
#define MISC_TAB        7

#else
# include <gtk/gtk.h>
# include <gdk/gdkkeysyms.h>

/* Older versions of GDK have different macros for keys */

# ifndef GDK_KEY_Up
#   define GDK_KEY_Up GDK_Up
# endif

# ifndef GDK_KEY_Down
#   define GDK_KEY_Down GDK_Down
# endif

# ifndef GDK_KEY_Tab
#   define GDK_KEY_Tab GDK_Tab
# endif

# ifndef GDK_KEY_ISO_Left_Tab
#   define GDK_KEY_ISO_Left_Tab GDK_ISO_Left_Tab
# endif

#endif

#include "MYODBC_MYSQL.h"
#include "installer.h"
#include "unicode_transcode.h"
#include <sql.h>
#include <vector>
#include <string>

#ifdef __cplusplus
extern "C" {
#endif
  /**
    This is the function implemented by the platform-specific code.

    @return TRUE if user pressed OK, FALSE if cancelled or closed
  */
  int ShowOdbcParamsDialog(DataSource* params, HWND ParentWnd, BOOL isPrompt);

#ifdef __cplusplus
}
#endif

extern bool is_unicode;

/* Utility functions. */
void ShowDiagnostics(SQLRETURN nReturn, SQLSMALLINT nHandleType, SQLHANDLE h);
void FreeEnvHandle(SQLHENV hEnv);
SQLRETURN Connect(SQLHDBC *hDbc, SQLHENV *hEnv, DataSource *params);
void Disconnect(SQLHDBC hDbc, SQLHENV hEnv);

/* Max DB name len, used when retrieving database list */
#define MYODBC_DB_NAME_MAX 255

/* Callbacks */
SQLWSTRING mytest(HWND hwnd, DataSource *params);
BOOL mytestaccept(HWND hwnd, DataSource *params);
std::vector<SQLWSTRING> mygetdatabases(HWND hwnd, DataSource *params);
std::vector<SQLWSTRING> mygetcharsets(HWND hwnd, DataSource *params);

/* Sync data functions */
void syncData(HWND hwnd, DataSource *params);
void syncForm(HWND hwnd, DataSource *params);
void syncTabsData(HWND hwnd, DataSource *params);
void syncTabs(HWND hwnd, DataSource *params);
void FillParameters(HWND hwnd, DataSource *params);

#define _W(string) wchar_t_as_sqlwchar((wchar_t*)string, (SQLWCHAR*)tmpbuf, \
                                        wcslen(string))



#ifdef _WIN32

SQLWCHAR * getStrFieldData(HWND hwnd, int idc);
SQLWCHAR * getStrFieldDataTab(unsigned int framenum, int idc );
void setStrFieldData(HWND hwnd, const SQLWCHAR *param, int idc);
void setStrFieldDataTab(const SQLWCHAR *param, unsigned int framenum, int idc );

void setComboFieldDataTab(const SQLWCHAR *param, unsigned int framenum, int idc);

my_bool getBoolFieldData(HWND hwnd, int idc);
my_bool getBoolFieldDataTab(unsigned int framenum, int idc);
void setBoolFieldDataTab(unsigned int framenum, int idc, my_bool state);
void setBoolFieldData(HWND hwnd, int idc, my_bool state);

unsigned int getUnsignedFieldData(HWND hwnd, int idc );
unsigned int getUnsignedFieldDataTab(unsigned int tab_num, int idc );
void setUnsignedFieldData(HWND hwnd, unsigned int param, int idc );
void setUnsignedFieldDataTab(unsigned int framenum, const unsigned int param, int idc);

HWND getTabCtrlTab(void);
HWND getTabCtrlTabPages(unsigned int framenum);
void SwitchTcpOrPipe(HWND hwnd, BOOL usePipe);
void setControlEnabled(unsigned int framenum, int idc, my_bool state);

#define GET_STRING(name) \
  {                                                                \
    SQLWCHAR *res = getStrFieldData(hwnd, IDC_EDIT_##name);        \
    if (res && *res)                                               \
      params->opt_##name = res;                                    \
    else                                                           \
      params->opt_##name.set_default(nullptr);                    \
  }

#define GET_STRING_TAB(framenum, name) \
  { \
    SQLWCHAR *res = getStrFieldDataTab(framenum, IDC_EDIT_##name); \
    if (res && *res) \
      params->opt_##name = res; \
    else \
      params->opt_##name.set_default(nullptr); \
  }

#define SET_STRING(name) \
  setStrFieldData(hwnd, params->opt_##name, IDC_EDIT_##name)

#define SET_STRING_TAB(framenum, name) \
  setStrFieldDataTab(params->opt_##name, framenum, IDC_EDIT_##name)

#define GET_COMBO(name) \
  GET_STRING(name)

#define GET_COMBO_TAB(framenum, name) \
  GET_STRING_TAB(framenum, name)

#define SET_COMBO(name) \
  SET_STRING(name)

#define SET_COMBO_TAB(framenum, name) \
  setComboFieldDataTab(params->opt_##name, framenum, IDC_EDIT_##name)

#define SET_CSTRING(name) \
    ComboBox_SetText(GetDlgItem(hwnd,IDC_EDIT_##name), params->opt_#name)

#define GET_UNSIGNED(name) { auto v = getUnsignedFieldData(hwnd, IDC_EDIT_##name); \
  if (v)                                                \
      params->opt_##name = v;                           \
    else                                                \
      params->opt_##name.set_default(0);                       \
  }
#define GET_UNSIGNED_TAB(framenum, name) { auto v = getUnsignedFieldDataTab(framenum, IDC_EDIT_##name); \
  if (v)                                                \
      params->opt_##name = v;                           \
    else                                                \
      params->opt_##name.set_default(0);         \
  }


#define SET_UNSIGNED(name) setUnsignedFieldData(hwnd, params->opt_##name, IDC_EDIT_##name)
#define SET_UNSIGNED_TAB(framenum, name)  setUnsignedFieldDataTab(framenum, params->opt_##name, IDC_EDIT_##name)


/* Definitions for BOOL inputs */
#define READ_BOOL(hwnd, name) \
    getBoolFieldData(hwnd, name)

#define READ_BOOL_TAB(framenum, name) \
    getBoolFieldDataTab(framenum, IDC_CHECK_##name)

#define SET_CHECKED(hwnd, name, state) \
  setBoolFieldData(hwnd, IDC_CHECK_##name, state)

#define SET_CHECKED_TAB(framenum, name, state) \
  setBoolFieldDataTab(framenum, IDC_CHECK_##name, state)

#define SET_RADIO(hwnd, name, state) \
  setBoolFieldData(hwnd, name, state)

#define SET_ENABLED(framenum, idc, state) \
  setControlEnabled(framenum, idc, state)


#else

void setSensitive(gchar *widget_name, gboolean state);
gboolean getBoolFieldData(gchar *widget_name);
void setBoolFieldData(gchar *widget_name, gboolean checked);
SQLWCHAR* getStrFieldData(gchar *widget_name);
SQLWCHAR* getComboFieldData(gchar *widget_name);
void setComboFieldData(gchar *widget_name, SQLCHAR *param);

/* param8 is the output buffer in UTF8 for GTK */
void setStrFieldData(gchar *widget_name, SQLCHAR *param);

unsigned int getUnsignedFieldData(gchar *widget_name);
void setUnsignedFieldData(gchar *widget_name, unsigned int param);

#define READ_BOOL(UNUSED_PARAM, name) \
  getBoolFieldData(#name)

#define READ_BOOL_TAB(UNUSED_PARAM, name) \
  READ_BOOL(UNUSED_PARAM, name)

#define SET_CHECKED(UNUSED_PARAM, name, state) \
  setBoolFieldData(#name, state)

#define SET_CHECKED_TAB(UNUSED_PARAM, name, state) \
  SET_CHECKED(UNUSED_PARAM, name, state)

#define GET_STRING(name) \
  {                                                                \
    SQLWCHAR *res = getStrFieldData(#name);                        \
    if (res && *res)                                               \
      params->opt_##name = res;                                    \
    else                                                           \
      params->opt_##name.set_default(nullptr);                     \
  }

#define GET_STRING_TAB(UNUSED_PARAM, name) \
  GET_STRING(name)

#define SET_STRING(name) \
  setStrFieldData(#name, params->opt_##name)

#define SET_STRING_TAB(UNUSED_PARAM, name) \
  SET_STRING(name)

#define SET_COMBO(name) \
  setComboFieldData(#name, params->opt_##name)

#define SET_COMBO_TAB(UNUSED_PARAM, name) \
  SET_COMBO(name)

#define GET_COMBO(name) \
  {                                                                \
    SQLWCHAR *res = getComboFieldData(#name);                      \
    if (res && *res)                                               \
      params->opt_##name = res;                                    \
    else                                                           \
      params->opt_##name.set_default(nullptr);                     \
  }

#define GET_COMBO_TAB(UNUSED_PARAM, name) \
  GET_COMBO(name)

#define GET_UNSIGNED(name)                                \
  {                                                       \
    auto v = getUnsignedFieldData(#name);                 \
    if (v)                                                \
      params->opt_##name = v;                             \
    else                                                  \
      params->opt_##name.set_default(0);           \
  }

#define GET_UNSIGNED_TAB(UNUSED_PARAM, name) \
  GET_UNSIGNED(name)

#define SET_UNSIGNED(name) \
  setUnsignedFieldData(#name, params->opt_##name)

#define SET_UNSIGNED_TAB(UNUSED_PARAM, name) \
  SET_UNSIGNED(name)

#define SET_SENSITIVE(name, state) \
  setSensitive((gchar*)#name, (gboolean)state)

#endif

#define GET_BOOL(hwnd, name)         \
  if (READ_BOOL(framenum, name))     \
    params->opt_##name = true;       \
  else                               \
    params->opt_##name.set_default(false)

#define GET_BOOL_TAB(framenum, name) \
  if (READ_BOOL_TAB(framenum, name)) \
    params->opt_##name = true;       \
  else                               \
    params->opt_##name.set_default(false)

#define SET_BOOL(hwnd, name) \
  SET_CHECKED(hwnd, name, params->opt_##name)

#define SET_BOOL_TAB(framenum, name) \
  SET_CHECKED_TAB(framenum, name, params->opt_##name)

#endif