class-support.lisp

   1 ;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10; Package: umlisp -*-
   2 ;;;; *************************************************************************
   3 ;;;; FILE IDENTIFICATION
   4 ;;;;
   5 ;;;; Name:         classes-support.lisp
   6 ;;;; Purpose:      Support for UMLisp classes
   7 ;;;; Author:       Kevin M. Rosenberg
   8 ;;;; Date Started: Apr 2000
   9 ;;;;
  10 ;;;; $Id: class-support.lisp,v 1.13 2003/06/15 07:48:30 kevin Exp $
  11 ;;;;
  12 ;;;; This file, part of UMLisp, is
  13 ;;;;    Copyright (c) 2000-2003 by Kevin M. Rosenberg, M.D.
  14 ;;;;
  15 ;;;; UMLisp users are granted the rights to distribute and use this software
  16 ;;;; as governed by the terms of the GNU General Public License.
  17 ;;;; *************************************************************************
  18
  19 (in-package #:umlisp)
  20
  21
  22 ;;; Formatting routines
  23
  24 (defgeneric fmt-cui (c))
  25 (defmethod fmt-cui ((c ucon))
  26   (fmt-cui (cui c)))
  27
  28 (defmethod fmt-cui ((c fixnum))
  29   (prefixed-fixnum-string c #\C 7))
  30
  31 (defmethod fmt-cui ((c string))
  32   (if (eql (aref c 0) #\C)
  33       c
  34       (fmt-cui (parse-integer c))))
  35
  36 (defmethod fmt-cui ((c null))
  37   (format nil "nil"))
  38
  39 (defgeneric fmt-lui (c))
  40 (defmethod fmt-lui ((l uterm))
  41   (fmt-lui (lui l)))
  42
  43 (defmethod fmt-lui ((l fixnum))
  44   (prefixed-fixnum-string l #\L 7))
  45
  46 (defmethod fmt-lui ((l string))
  47   (if (eql (aref l 0) #\L)
  48       l
  49       (fmt-lui (parse-integer l))))
  50
  51 (defgeneric fmt-sui (s))
  52 (defmethod fmt-sui ((s ustr))
  53   (fmt-sui (sui s)))
  54
  55 (defmethod fmt-sui ((s fixnum))
  56   (prefixed-fixnum-string s #\S 7))
  57
  58 (defmethod fmt-sui ((s string))
  59   (if (eql (aref s 0) #\S)
  60       s
  61       (fmt-sui (parse-integer s))))
  62
  63 (defgeneric fmt-tui (tui))
  64 (defmethod fmt-tui ((tui fixnum))
  65   (prefixed-fixnum-string tui #\T 3))
  66
  67 (defmethod fmt-tui ((tui string))
  68   (if (eql (aref tui 0) #\T)
  69       tui
  70       (fmt-tui (parse-integer tui))))
  71
  72 (defgeneric fmt-eui (e))
  73 (defmethod fmt-eui ((e fixnum))
  74   (prefixed-fixnum-string e #\E 7))
  75
  76 (defmethod fmt-eui ((e string))
  77   (if (eql (aref e 0) #\E)
  78       e
  79       (fmt-eui (parse-integer e))))
  80
  81 (defmethod fmt-eui ((e null))
  82   (format nil "nil"))
  83
  84 (defun cui-p (ui)
  85   "Check if a string is a CUI"
  86   (check-ui ui #\C 7))
  87
  88 (defun lui-p (ui)
  89   "Check if a string is a LUI"
  90   (check-ui ui #\L 7))
  91
  92 (defun sui-p (ui)
  93   "Check if a string is a SUI"
  94   (check-ui ui #\S 7))
  95
  96 (defun tui-p (ui)
  97   (check-ui ui #\T 3))
  98
  99 (defun eui-p (ui)
 100   (check-ui ui #\E 7))
 101
 102 (defun check-ui (ui start-char len)
 103   (when (and (stringp ui)
 104              (= (length ui) (1+ len))
 105              (char-equal start-char (schar ui 0))
 106              (ignore-errors (parse-integer ui :start 1)))
 107     t))
 108
 109
 110 ;;; Generic display functions
 111
 112 (eval-when (:compile-toplevel :load-toplevel :execute)
 113 (defun english-term-p (obj)
 114   "Returns two values: T/NIL if term is english and T/NIL if obj is a TERM"
 115   (if (eq (hyperobject::class-name (hyperobject::class-of obj)) 'uterm)
 116       (values (string-equal (lat obj) "ENG") t)
 117     (values nil nil))))
 118
 119 (defun english-term-filter (obj)
 120   "Retrns NIL if object is a term and not english"
 121   (multiple-value-bind (is-english is-term) (english-term-p obj)
 122       (or (not is-term) is-english)))
 123
 124 (defun print-umlsclass (obj &key (stream *standard-output*)
 125                         (category :compact-text)
 126                         (file-wrapper t) (english-only t) (subobjects nil)
 127                         (refvars nil) (link-printer nil))
 128   (view obj :stream stream :category category :subobjects subobjects
 129         :file-wrapper file-wrapper
 130         :filter (if english-only nil #'english-term-filter)
 131         :link-printer link-printer
 132         :refvars refvars))
 133
 134 (defmacro define-lookup-display (newfuncname lookup-func)
 135   "Defines functions for looking up and displaying objects"
 136   `(defun ,newfuncname  (keyval &key (stream *standard-output*) (category :compact-text)
 137                          (file-wrapper t) (english-only nil) (subobjects nil))
 138      (let ((obj (funcall ,lookup-func keyval)))
 139        (print-umlsclass obj :stream stream :category category
 140                         :file-wrapper file-wrapper :english-only english-only
 141                         :subobjects subobjects)
 142        obj)))
 143
 144 (define-lookup-display display-con #'find-ucon-cui)
 145 (define-lookup-display display-term #'find-uterm-lui)
 146 (define-lookup-display display-str #'find-ustr-sui)
 147
 148 (defun ucon-has-tui (ucon tui)
 149   "Returns T if UCON has a semantic type of TUI."
 150   (some #'(lambda (usty) (= tui (tui usty))) (s#sty ucon)))
 151
 152 (defgeneric suistr (lo))
 153 (defmethod suistr ((lo ulo))
 154   "Return the string for a ulo object"
 155   (find-string-sui (sui lo)))
 156
 157 (defun uterm-pfstr (uterm)
 158   "Return the preferred string for a uterm"
 159   (dolist (ustr (s#str uterm))
 160     (when (string= "PF" (stt ustr))
 161       (return-from uterm-pfstr (str ustr)))))
 162
 163 (defun remove-non-english-terms (uterms)
 164   (remove-if-not #'english-term-p uterms))
 165
 166
 167 #+(or scl cmu)
 168 (dolist (c '(urank udef usat uso ucxt ustr ulo uterm usty urel ucoc uatx ucon uxw uxnw uxns lexterm labr lagr lcmp lmod lnom lprn lprp lspl ltrm ltyp lwd sdef sstr sstre1 sstre2 usrl))
 169     #+cmu
 170     (let ((cl (pcl:find-class c)))
 171       (pcl:finalize-inheritance cl))
 172     #+scl
 173     (let ((cl (find-class c)))
 174       (clos:finalize-inheritance cl)))