Changeset 35229 in project


Ignore:
Timestamp:
03/01/18 03:12:11 (4 months ago)
Author:
kon
Message:

rel 2.2.0

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/macosx

    r28426 r35229  
    1919</enscript>
    2020
     21==== Notes
     22
     23; {{STORE}} : {{(or #f (c-pointer SCDynamicStoreRef))}}.
     24
    2125==== machine-name
    2226
    23 <procedure>(machine-name) => STRING</procedure>
     27<procedure>(machine-name) -> string</procedure>
    2428
    2529The machine name from core services. Probably not the same as
     
    2832==== short-user-name
    2933
    30 <procedure>(short-user-name) => STRING</procedure>
     34<procedure>(short-user-name) -> string</procedure>
    3135
    3236The short name for the user. Based on the current process uid.
     
    3438==== long-user-name
    3539
    36 <procedure>(long-user-name) => STRING</procedure>
     40<procedure>(long-user-name) -> string</procedure>
    3741
    3842The long name for the user. Based on the current process uid.
     
    4044==== machine-location
    4145
    42 <procedure>(machine-location) => VECTOR/4</procedure>
     46<procedure>(machine-location) -> vector</procedure>
    4347
    4448Returns a 4 element vector:
    4549
    46 ; LATITUDE : Latitude in degrees north to 2 decimal places.
    47 ; LONGITUDE : Longitude in degrees east to 2 decimal places.
    48 ; DLS-OFFSET : Number of seconds to add for daylight saving time.
    49 ; GMT-OFFSET : Number of seconds east of GMT, includes daylight saving time status.
     50; LATITUDE : {{inexact}} ; Latitude in degrees north to 2 decimal places.
     51; LONGITUDE : {{inexact}} ; Longitude in degrees east to 2 decimal places.
     52; DLS-OFFSET : {{fixnum}} ; Number of seconds to add for daylight saving time.
     53; GMT-OFFSET : {{fixnum}} ; Number of seconds east of GMT, includes daylight saving time status.
    5054
    5155==== metric?
    5256
    53 <procedure>(metric?) => BOOLEAN</procedure>
     57<procedure>(metric?) -> boolean</procedure>
    5458
    5559Using the metric system?
    5660
    57 DEPERECATED
    58 
    5961==== computer-name
    6062
    61 <procedure>(computer-name [STORE]) => STRING</procedure>
     63<procedure>(computer-name [STORE]) -> string</procedure>
    6264
    6365The computer name from system configuration.
     
    6567==== console-user
    6668
    67 <procedure>(console-user [STORE]) => VECTOR/3</procedure>
    68 
    69 Returns a 3 element vector:
    70 
    71 ; NAME : The (short) name of the console user.
    72 ; UID : The user id of the console user.
    73 ; GID : The group id of the console user.
     69<procedure>(console-user [STORE]) -> (or boolean vector)</procedure>
     70
     71Returns a 3 element vector or {{#f}} for failure.
     72
     73; NAME : {{string}} ; The (short) name of the console user.
     74; UID : {{fixnum}} ; The user id of the console user.
     75; GID : {{fixnum}} ; The group id of the console user.
    7476
    7577==== local-host-name
    7678
    77 <procedure>(local-host-name [STORE]) => STRING</procedure>
     79<procedure>(local-host-name [STORE]) -> string</procedure>
    7880
    7981The local host name from system configuration. Probably not the same as
     
    8284==== location-name
    8385
    84 <procedure>(location-name [STORE]) => STRING</procedure>
     86<procedure>(location-name [STORE]) -> string</procedure>
    8587
    8688The location.
     
    8890==== session-info
    8991
    90 <procedure>(session-info) => VECTOR/10</procedure>
     92<procedure>(session-info) -> vector</procedure>
    9193
    9294Returns a 10 element vector:
    9395
    94 ; SESSION-ID : The security session identifier number.
    95 ; IS-ROOT : A root session?
    96 ; HAS-GRAPHICS : Has graphics access?
    97 ; HAS-TTY : Has tty?
    98 ; IS-REMOTE : Is a remote session?
    99 ; WAS-INITIALIZED : Initialized? (see note below)
    100 ; SHORT-USER-NAME : Short user name.
    101 ; USER-ID : User identification number.
    102 ; CONSOLE-SET : Console hardware number.
    103 ; LOGIN-COMPLETED : Login operations complete?
    104 ; IS-USER-ACTIVE : On console?
    105 
    106 The OS API behind {{WAS-INITIALIZED}} is unsupported in MacOS 10.7 so to indicate
     96; SESSION-ID : {{fixnum}} ; The security session identifier number.
     97; IS-ROOT : {{boolean}} ; A root session?
     98; HAS-GRAPHICS : {{boolean}} ; Has graphics access?
     99; HAS-TTY : {{boolean}} ; Has tty?
     100; IS-REMOTE : {{boolean}} ; Is a remote session?
     101; WAS-INITIALIZED : {{boolean}} ; Initialized? (see note below)
     102; SHORT-USER-NAME : {{string}} ; Short user name.
     103; USER-ID : {{fixnum}} ; User identification number.
     104; CONSOLE-SET : {{fixnum}} ; Console hardware number.
     105; LOGIN-COMPLETED : {{boolean}} ; Login operations complete?
     106; IS-USER-ACTIVE : {{boolean}} ; On console?
     107
     108The OS API behind {{WAS-INITIALIZED}} is unsupported as of macOS 10.7 so to indicate
    107109the value is {{(void)}}.
    108110
     111Raises an {{osstatus-condition}} for failure.
     112
    109113==== main-bundle-path
    110114
    111 <procedure>(main-bundle-path) => STRING</procedure>
     115<procedure>(main-bundle-path) -> string</procedure>
    112116
    113117The full pathname of the currently running executable, including the program
     
    116120==== tick-count
    117121
    118 <procedure>(tick-count) => INTEGER</procedure>
     122<procedure>(tick-count) -> number</procedure>
    119123
    120124Returns an unsigned 32-bit integer that indicates the current number of ticks
     
    123127==== delay
    124128
    125 <procedure>(delay TICKS) => INTEGER</procedure>
     129<procedure>(delay TICKS) -> number</procedure>
    126130
    127131Suspend execution for the specified number of {{TICKS}}. Returns an unsigned
     
    130134==== gestalt
    131135
    132 <procedure>(gestalt SELECTOR) => INTEGER</procedure>
     136<procedure>(gestalt SELECTOR) -> number</procedure>
    133137
    134138Calls the Gestalt Manager with specified {{SELECTOR}} and returns an unsigned
    13513932-bit integer.
    136140
    137 The {{SELECTOR}} can be a string, symbol, or an unsigned integer. When a string
    138 or symbol it is converted to a Macintosh 4-byte character value - an unsigned
    139 32-bit integer. The string length may not be greater than 4 but can be less;
    140 space padding will be performed.
     141; {{SELECTOR}} : {{(or string symbol number)}}.
     142
     143An {{(or string symbol)}} is converted to a Macintosh 4-byte character value.
     144The string length may not be greater than 4 but can be less; space padding
     145will be performed.
     146
     147Raises an {{oserr-condition}} for failure.
     148
     149=== Error Conditons
     150
     151==== Usage
     152
     153<enscript language=scheme>
     154(require-extension macosx-errors)
     155</enscript>
    141156
    142157==== osstatus-condition?
    143158
    144 <procedure>(osstatus-condition? OBJECT) => boolean</procedure>
     159<procedure>(osstatus-condition? OBJ) -> boolean</procedure>
     160
     161Is {{OBJ}} an {{osstatus}} {{condition}}?
    145162
    146163==== oserr-condition?
    147164
    148 <procedure>(oserr-condition? OBJECT) => boolean</procedure>
    149 
     165<procedure>(oserr-condition? OBJ) -> boolean</procedure>
     166
     167Is {{OBJ}} an {{oserr}} {{condition}}?
    150168
    151169=== URL Support
     
    159177==== open-url
    160178
    161 <procedure>(open-url URL-STRING)</procedure>
    162 
    163 Opens the {{URL-STRING}} using the system-dependent default application.
    164 
    165 ==== osstatus-condition?
    166 
    167 <procedure>(osstatus-condition? OBJECT) => boolean</procedure>
     179<procedure>(open-url URL)</procedure>
     180
     181Opens the {{(: URL string}} using the system-dependent default application.
    168182
    169183
    170184== Notes
    171185
    172 * The MacOS APIs are not properly tracked & this extension is out-of-date.
    173 
    174186* The utility of {{gestalt}} is almost none now.
     187
     188
     189== Bugs & Limitations
     190
     191* The {{macosx-env}} module is on ''life-support''.
    175192
    176193* {{sessionWasInitialized}} was removed as of MacOS 10.7 (Lion).
     
    183200[[condition-utils]]
    184201
     202[[test]]
     203[[setup-helper]]
     204
    185205
    186206== Author
     
    191211== Version history
    192212
     213; 2.2.0 : Remove {{osstatus-condition?}}, & {{oserr-condition?}}
    193214; 2.1.4 : Fix for ticket #630.
    194215; 2.1.3 : Gestalt defunct & sessionWasInitialized not Lion.
     
    201222== License
    202223
    203 Copyright (C) 2009 Kon Lovett.  All rights reserved.
     224Copyright (C) 2009-2018 Kon Lovett.  All rights reserved.
    204225
    205226Permission is hereby granted, free of charge, to any person obtaining a
Note: See TracChangeset for help on using the changeset viewer.