r11140: do not export internal functions
[umlisp.git] / utils.lisp
1 ;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10; Package: umlisp -*-
2 ;;;; *************************************************************************
3 ;;;; FILE IDENTIFICATION
4 ;;;;
5 ;;;; Name:     utils.lisp
6 ;;;; Purpose:  Low-level utility functions for UMLisp
7 ;;;; Author:   Kevin M. Rosenberg
8 ;;;; Created:  Apr 2000
9 ;;;;
10 ;;;; $Id$
11 ;;;;
12 ;;;; This file, part of UMLisp, is
13 ;;;;    Copyright (c) 2000-2006 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 (declaim (inline make-cuisui make-cuilui parse-ui parse-cui))
22
23 (defmacro def-metaclass-reader (field)
24   "Create function for reading slot of metaclass"
25   `(defun ,field (cl)
26      (car (slot-value (class-of cl) ',field))))
27
28 (defmacro def-metaclass-reader-car (field)
29   "Create function for reading slot of metaclass"
30   `(defun ,field (cl)
31      (car (slot-value (class-of cl) ',field))))
32
33 ;;; Field transformations
34
35 (defun parse-ui (s &optional (nullvalue 0))
36   "Return integer value for a UMLS unique identifier."
37   (declare (simple-string s)
38            (optimize (speed 3) (safety 0)))
39   (if (< (length s) 2)
40       nullvalue
41     (nth-value 0 (parse-integer s :start 1))))
42
43 (defun parse-cui (cui)
44   (declare (optimize (speed 3) (safety 0)))
45   (if (stringp cui)
46       (let ((ch (schar cui 0)))
47         (if (char-equal ch #\C)
48             (parse-ui cui)
49             (nth-value 0 (parse-integer cui))))
50     cui))
51     
52 (defun parse-lui (lui)
53   (declare (optimize (speed 3) (safety 0)))
54   (if (stringp lui)
55       (let ((ch (schar lui 0)))
56         (if (char-equal ch #\L)
57             (parse-ui lui)
58             (nth-value 0 (parse-integer lui))))
59     lui))
60     
61 (defun parse-sui (sui)
62   (declare (optimize (speed 3) (safety 0)))
63   (if (stringp sui)
64       (let ((ch (schar sui 0)))
65         (if (char-equal ch #\S)
66             (parse-ui sui)
67             (nth-value 0 (parse-integer sui))))
68     sui))
69     
70 (defun parse-tui (tui)
71   (declare (optimize (speed 3) (safety 0)))
72   (if (stringp tui)
73       (let ((ch (schar tui 0)))
74         (if (char-equal ch #\T)
75             (parse-ui tui)
76             (nth-value 0 (parse-integer tui))))
77     tui))
78
79 (defun parse-aui (aui)
80   (declare (optimize (speed 3) (safety 0)))
81   (if (stringp aui)
82       (let ((ch (schar aui 0)))
83         (if (char-equal ch #\A)
84             (parse-ui aui)
85             (nth-value 0 (parse-integer aui))))
86     aui))
87
88 (defun parse-eui (eui)
89   (declare (optimize (speed 3) (safety 0)))
90   (if (stringp eui)
91       (let ((ch (schar eui 0)))
92         (if (char-equal ch #\E)
93             (parse-ui eui)
94             (nth-value 0 (parse-integer eui))))
95     eui))
96     
97 (defconstant +cuisui-scale+ 10000000)
98 (declaim (type (integer 0 10000000) +cuisui-scale+))
99
100 #+64bit
101 (defun make-cuisui (cui sui)
102   (declare (fixnum cui sui)
103            (optimize (speed 3) (safety 0) (space 0)))
104   (the fixnum 
105     (+ (the fixnum (* +cuisui-scale+ cui)) sui)))
106
107 #-64bit
108 (defun make-cuisui (cui sui)
109   (declare (fixnum cui sui)
110            (optimize (speed 3) (safety 0) (space 0)))
111   (+ (* +cuisui-scale+ cui) sui))
112
113 #+64bit
114 (defun make-cuilui (cui lui)
115   (declare (fixnum cui lui)
116            (optimize (speed 3) (safety 0) (space 0)))
117   (the fixnum 
118     (+ (the fixnum (* +cuisui-scale+ cui)) lui)))
119
120 #-64bit
121 (defun make-cuilui (cui lui)
122   (declare (fixnum cui lui)
123            (optimize (speed 3) (safety 0) (space 0)))
124   (+ (* +cuisui-scale+ cui) lui))
125
126 (defun decompose-cuisui (cuisui)
127   "Returns the CUI and SUI of a cuisui number"
128   #-64bit (declare (integer cuisui))
129   #+64bit (declare (fixnum cuisui))
130   (floor cuisui +cuisui-scale+))
131
132 ;;; Lookup functions for uterms,ustr in ucons
133
134 (defun find-uterm-in-ucon (ucon lui)
135   (find lui (s#term ucon) :key #'lui :test 'equal))
136
137 (defun find-ustr-in-uterm (uterm sui)
138   (find sui (s#str uterm) :key #'sui :test 'equal))
139
140 (defun find-ustr-in-ucon (ucon sui)
141   (dolist (uterm (s#term ucon))
142     (dolist (ustr (s#str uterm))
143       (when (string-equal sui (sui ustr))
144         (return-from find-ustr-in-ucon ustr)))))