;;; -*- Mode: LISP; Syntax: COMMON-LISP; Package: FM-PLUGIN-TOOLS; Base: 10 -*-
;;; $Header: /usr/local/cvsrep/fm-plugin-tools/specials.lisp,v 1.9 2010/07/22 09:38:06 edi Exp $

;;; Copyright (c) 2006-2010, Dr. Edmund Weitz.  All rights reserved.

;;; Redistribution and use in source and binary forms, with or without
;;; modification, are permitted provided that the following conditions
;;; are met:

;;;   * Redistributions of source code must retain the above copyright
;;;     notice, this list of conditions and the following disclaimer.

;;;   * Redistributions in binary form must reproduce the above
;;;     copyright notice, this list of conditions and the following
;;;     disclaimer in the documentation and/or other materials
;;;     provided with the distribution.

;;; THIS SOFTWARE IS PROVIDED BY THE AUTHOR 'AS IS' AND ANY EXPRESSED
;;; OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
;;; WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
;;; ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
;;; DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
;;; DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
;;; GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
;;; INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
;;; WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
;;; NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
;;; SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

(in-package :fm-plugin-tools)

(defvar *plugin-id*)
(defvar *plugin-name*)
#+:macosx
(defvar *plugin-bundle-identifier*)
(defvar *plugin-help-text*)
(defvar *plugin-version*)
(defvar *copyright-message*)
(defvar *company-name*)

;; we set the documentation here so that the values above stay unbound
(setf (documentation '*plugin-id* 'variable)
      "The ID of the plug-in.  A four character creator code - see
FileMaker documentation."
      (documentation '*plugin-name* 'variable)
      "The name of the plug-in."
      #+:macosx #+:macosx
      (documentation '*plugin-bundle-identifier* 'variable)
      "Used as the `CFBundleIdentifier' for the bundles generated on OS X."
      (documentation '*plugin-help-text* 'variable)
      "The help text for the plug-in to display in FileMaker's
preferences dialog box."
      (documentation '*plugin-version* 'variable)
      "Version number of the plug-in.  Should be a list of at
most four integers, e.g. (4 2 1) would correspond to version
\"4.2.1\"."
      (documentation '*company-name* 'variable)
      "The name of the company which created the plug-in.  Will
be used for entries into the Windows registry and in the DLL
version info."
      (documentation '*copyright-message* 'variable)
      "The copyright message for the DLL version info.")

(defvar *product-name* nil
  "Will be used as the product name for the DLL version info.
The default value is NIL.  If no name is set, *PLUGIN-NAME* is
used instead.")

(defvar *enable-idle-messages* nil
  "Whether we want to receive \(and handle) kFMXT_Idle messages from
FileMaker.")

(defvar *fm-logfile* t
  "Target file for the FM-LOG function.  A pathname designator,
or T for a default location in the user's local application data
folder, or NIL for no logging at all.")

(defvar *parameter-block* nil
  "A pointer to the FMX_ExternCallStruct C struct that holds the
parameters for the most recent call into FMExternCallProc.  This
is for example needed if we want to call a script - see
FMX-START-SCRIPT.")

(defvar *preferences-function* nil
  "A function designator for a 0-ary function to handle
configuration options \(in FileMaker's preferences dialog box)
for the plug-in user - or NIL if we don't want to do that.")

(defvar *init-function* nil
  "A function designator for a 0-ary function which is called
when the plug-in is initialized - or NIL if we don't want to be
called.")

(defvar *shutdown-function* nil
  "A function designator for a 0-ary function which is called
when the plug-in is shut down - or NIL if we don't want to be
called.")

(defparameter *last-gc* (load-time-value (get-universal-time))
  "The last time we collected all generations.")

(defvar *gc-interval* 600
  "How often \(in seconds) to collect all generations if the user
is idle.  This will only happen if idle messages are enabled.
Set to NIL if you don't want explicit collections.")

(defparameter *plugin-functions* nil
  "A list which keeps information about all functions which have
been defined with DEFINE-PLUGIN-FUNCTION.")

(defparameter *function-counter* -1
  "A counter used to give a unique numerical ID to each function
defined with DEFINE-PLUGIN-FUNCTION.")

(defvar *log-errors-p* t
  "Whether errors occurring during the execution of a plug-in
function should be logged using FM-LOG.")

(defvar *log-backtraces-p* nil
  "Whether error log entries created due to *LOG-ERROR-P* should
be followed by a backtrace.")

(defvar *symbols-to-keep* nil
  "The list of symbols which must remain in the delivered DLL
image.  Only needed for delivery level 5.")

(defvar *environment* nil
  "During the execution of a plug-in function this variable is bound
to the environment parameter.  Needed for example by the EVALUATE
function.  Should not be accessed directly, but only with
GET-ENVIRONMENT function.")

(defvar *args*)
(defvar *results*)

;; we set the documentation here so that the values above stay unbound
(setf (documentation '*args* 'variable)
      "During the execution of a plug-in function this variable
is bound to the argument vector.  See function NTH-ARG."
      (documentation '*results* 'variable)
      "During the execution of a plug-in function this variable
is bound to the object which will eventually contain the return
value.  See function SET-VALUE.")

(defvar *global-environment* nil
  "A fallback environment which can stand in for *ENVIRONMENT* if it's
not NIL.  Should not be accessed directly, but only with
GET-ENVIRONMENT function.")

(defvar *global-environment-lock* (mp:make-lock :name "global-environment-lock")
  "A lock to protect updates to the *GLOBAL-ENVIRONMENT* variable.")