/ Hex Artifact Content
Login

Artifact 1f825a8ec854abe8f4cd3a1851c5f6c43e58fbf8:


0000: 2f 2a 0a 2a 2a 20 32 30 30 31 20 53 65 70 74 65  /*.** 2001 Septe
0010: 6d 62 65 72 20 31 36 0a 2a 2a 0a 2a 2a 20 54 68  mber 16.**.** Th
0020: 65 20 61 75 74 68 6f 72 20 64 69 73 63 6c 61 69  e author disclai
0030: 6d 73 20 63 6f 70 79 72 69 67 68 74 20 74 6f 20  ms copyright to 
0040: 74 68 69 73 20 73 6f 75 72 63 65 20 63 6f 64 65  this source code
0050: 2e 20 20 49 6e 20 70 6c 61 63 65 20 6f 66 0a 2a  .  In place of.*
0060: 2a 20 61 20 6c 65 67 61 6c 20 6e 6f 74 69 63 65  * a legal notice
0070: 2c 20 68 65 72 65 20 69 73 20 61 20 62 6c 65 73  , here is a bles
0080: 73 69 6e 67 3a 0a 2a 2a 0a 2a 2a 20 20 20 20 4d  sing:.**.**    M
0090: 61 79 20 79 6f 75 20 64 6f 20 67 6f 6f 64 20 61  ay you do good a
00a0: 6e 64 20 6e 6f 74 20 65 76 69 6c 2e 0a 2a 2a 20  nd not evil..** 
00b0: 20 20 20 4d 61 79 20 79 6f 75 20 66 69 6e 64 20     May you find 
00c0: 66 6f 72 67 69 76 65 6e 65 73 73 20 66 6f 72 20  forgiveness for 
00d0: 79 6f 75 72 73 65 6c 66 20 61 6e 64 20 66 6f 72  yourself and for
00e0: 67 69 76 65 20 6f 74 68 65 72 73 2e 0a 2a 2a 20  give others..** 
00f0: 20 20 20 4d 61 79 20 79 6f 75 20 73 68 61 72 65     May you share
0100: 20 66 72 65 65 6c 79 2c 20 6e 65 76 65 72 20 74   freely, never t
0110: 61 6b 69 6e 67 20 6d 6f 72 65 20 74 68 61 6e 20  aking more than 
0120: 79 6f 75 20 67 69 76 65 2e 0a 2a 2a 0a 2a 2a 2a  you give..**.***
0130: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0140: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0150: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0160: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0170: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 0a 2a 2a 0a 2a  ***********.**.*
0180: 2a 20 54 68 69 73 20 68 65 61 64 65 72 20 66 69  * This header fi
0190: 6c 65 20 28 74 6f 67 65 74 68 65 72 20 77 69 74  le (together wit
01a0: 68 20 69 73 20 63 6f 6d 70 61 6e 69 6f 6e 20 43  h is companion C
01b0: 20 73 6f 75 72 63 65 2d 63 6f 64 65 20 66 69 6c   source-code fil
01c0: 65 0a 2a 2a 20 22 6f 73 2e 63 22 29 20 61 74 74  e.** "os.c") att
01d0: 65 6d 70 74 20 74 6f 20 61 62 73 74 72 61 63 74  empt to abstract
01e0: 20 74 68 65 20 75 6e 64 65 72 6c 79 69 6e 67 20   the underlying 
01f0: 6f 70 65 72 61 74 69 6e 67 20 73 79 73 74 65 6d  operating system
0200: 20 73 6f 20 74 68 61 74 0a 2a 2a 20 74 68 65 20   so that.** the 
0210: 53 51 4c 69 74 65 20 6c 69 62 72 61 72 79 20 77  SQLite library w
0220: 69 6c 6c 20 77 6f 72 6b 20 6f 6e 20 62 6f 74 68  ill work on both
0230: 20 50 4f 53 49 58 20 61 6e 64 20 77 69 6e 64 6f   POSIX and windo
0240: 77 73 20 73 79 73 74 65 6d 73 2e 0a 2a 2f 0a 23  ws systems..*/.#
0250: 69 66 6e 64 65 66 20 5f 53 51 4c 49 54 45 5f 4f  ifndef _SQLITE_O
0260: 53 5f 48 5f 0a 23 64 65 66 69 6e 65 20 5f 53 51  S_H_.#define _SQ
0270: 4c 49 54 45 5f 4f 53 5f 48 5f 0a 23 69 6e 63 6c  LITE_OS_H_.#incl
0280: 75 64 65 20 22 73 71 6c 69 74 65 33 5f 61 75 78  ude "sqlite3_aux
0290: 2e 68 22 0a 0a 2f 2a 0a 2a 2a 20 46 69 67 75 72  .h"../*.** Figur
02a0: 65 20 6f 75 74 20 69 66 20 77 65 20 61 72 65 20  e out if we are 
02b0: 64 65 61 6c 69 6e 67 20 77 69 74 68 20 55 6e 69  dealing with Uni
02c0: 78 2c 20 57 69 6e 64 6f 77 73 20 6f 72 20 4d 61  x, Windows or Ma
02d0: 63 4f 53 2e 0a 2a 2a 0a 2a 2a 20 4e 2e 42 2e 20  cOS..**.** N.B. 
02e0: 4d 61 63 4f 53 20 6d 65 61 6e 73 20 4d 61 63 20  MacOS means Mac 
02f0: 43 6c 61 73 73 69 63 20 28 6f 72 20 43 61 72 62  Classic (or Carb
0300: 6f 6e 29 2e 20 54 72 65 61 74 20 44 61 72 77 69  on). Treat Darwi
0310: 6e 20 28 4f 53 20 58 29 20 61 73 20 55 6e 69 78  n (OS X) as Unix
0320: 2e 0a 2a 2a 20 20 20 20 20 20 54 68 65 20 4d 61  ..**      The Ma
0330: 63 4f 53 20 62 75 69 6c 64 20 69 73 20 64 65 73  cOS build is des
0340: 69 67 6e 65 64 20 74 6f 20 75 73 65 20 43 6f 64  igned to use Cod
0350: 65 57 61 72 72 69 6f 72 20 28 74 65 73 74 65 64  eWarrior (tested
0360: 20 77 69 74 68 20 76 38 29 0a 2a 2f 0a 23 69 66   with v8).*/.#if
0370: 20 21 64 65 66 69 6e 65 64 28 4f 53 5f 55 4e 49   !defined(OS_UNI
0380: 58 29 20 26 26 20 21 64 65 66 69 6e 65 64 28 4f  X) && !defined(O
0390: 53 5f 41 4c 54 29 0a 23 20 64 65 66 69 6e 65 20  S_ALT).# define 
03a0: 4f 53 5f 4f 54 48 45 52 20 30 0a 23 20 69 66 6e  OS_OTHER 0.# ifn
03b0: 64 65 66 20 4f 53 5f 57 49 4e 0a 23 20 20 20 69  def OS_WIN.#   i
03c0: 66 20 64 65 66 69 6e 65 64 28 5f 57 49 4e 33 32  f defined(_WIN32
03d0: 29 20 7c 7c 20 64 65 66 69 6e 65 64 28 57 49 4e  ) || defined(WIN
03e0: 33 32 29 20 7c 7c 20 64 65 66 69 6e 65 64 28 5f  32) || defined(_
03f0: 5f 43 59 47 57 49 4e 5f 5f 29 20 7c 7c 20 64 65  _CYGWIN__) || de
0400: 66 69 6e 65 64 28 5f 5f 4d 49 4e 47 57 33 32 5f  fined(__MINGW32_
0410: 5f 29 20 7c 7c 20 64 65 66 69 6e 65 64 28 5f 5f  _) || defined(__
0420: 42 4f 52 4c 41 4e 44 43 5f 5f 29 0a 23 20 20 20  BORLANDC__).#   
0430: 20 20 64 65 66 69 6e 65 20 4f 53 5f 57 49 4e 20    define OS_WIN 
0440: 31 0a 23 20 20 20 20 20 64 65 66 69 6e 65 20 4f  1.#     define O
0450: 53 5f 55 4e 49 58 20 30 0a 23 20 20 20 65 6c 73  S_UNIX 0.#   els
0460: 65 0a 23 20 20 20 20 20 64 65 66 69 6e 65 20 4f  e.#     define O
0470: 53 5f 57 49 4e 20 30 0a 23 20 20 20 20 20 64 65  S_WIN 0.#     de
0480: 66 69 6e 65 20 4f 53 5f 55 4e 49 58 20 31 0a 23  fine OS_UNIX 1.#
0490: 20 20 65 6e 64 69 66 0a 23 20 65 6c 73 65 0a 23    endif.# else.#
04a0: 20 20 64 65 66 69 6e 65 20 4f 53 5f 55 4e 49 58    define OS_UNIX
04b0: 20 30 0a 23 20 65 6e 64 69 66 0a 23 65 6c 73 65   0.# endif.#else
04c0: 0a 23 20 69 66 6e 64 65 66 20 4f 53 5f 57 49 4e  .# ifndef OS_WIN
04d0: 0a 23 20 20 64 65 66 69 6e 65 20 4f 53 5f 57 49  .#  define OS_WI
04e0: 4e 20 30 0a 23 20 65 6e 64 69 66 0a 23 65 6e 64  N 0.# endif.#end
04f0: 69 66 0a 0a 0a 2f 2a 0a 2a 2a 20 44 65 66 69 6e  if.../*.** Defin
0500: 65 20 74 68 65 20 6d 61 78 69 6d 75 6d 20 73 69  e the maximum si
0510: 7a 65 20 6f 66 20 61 20 74 65 6d 70 6f 72 61 72  ze of a temporar
0520: 79 20 66 69 6c 65 6e 61 6d 65 0a 2a 2f 0a 23 69  y filename.*/.#i
0530: 66 20 4f 53 5f 57 49 4e 0a 23 20 69 6e 63 6c 75  f OS_WIN.# inclu
0540: 64 65 20 3c 77 69 6e 64 6f 77 73 2e 68 3e 0a 23  de <windows.h>.#
0550: 20 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 54   define SQLITE_T
0560: 45 4d 50 4e 41 4d 45 5f 53 49 5a 45 20 28 4d 41  EMPNAME_SIZE (MA
0570: 58 5f 50 41 54 48 2b 35 30 29 0a 23 65 6c 73 65  X_PATH+50).#else
0580: 0a 23 20 64 65 66 69 6e 65 20 53 51 4c 49 54 45  .# define SQLITE
0590: 5f 54 45 4d 50 4e 41 4d 45 5f 53 49 5a 45 20 32  _TEMPNAME_SIZE 2
05a0: 30 30 0a 23 65 6e 64 69 66 0a 0a 2f 2a 20 49 66  00.#endif../* If
05b0: 20 74 68 65 20 53 45 54 5f 46 55 4c 4c 53 59 4e   the SET_FULLSYN
05c0: 43 20 6d 61 63 72 6f 20 69 73 20 6e 6f 74 20 64  C macro is not d
05d0: 65 66 69 6e 65 64 20 61 62 6f 76 65 2c 20 74 68  efined above, th
05e0: 65 6e 20 6d 61 6b 65 20 69 74 0a 2a 2a 20 61 20  en make it.** a 
05f0: 6e 6f 2d 6f 70 0a 2a 2f 0a 23 69 66 6e 64 65 66  no-op.*/.#ifndef
0600: 20 53 45 54 5f 46 55 4c 4c 53 59 4e 43 0a 23 20   SET_FULLSYNC.# 
0610: 64 65 66 69 6e 65 20 53 45 54 5f 46 55 4c 4c 53  define SET_FULLS
0620: 59 4e 43 28 78 2c 79 29 0a 23 65 6e 64 69 66 0a  YNC(x,y).#endif.
0630: 0a 2f 2a 0a 2a 2a 20 54 65 6d 70 6f 72 61 72 79  ./*.** Temporary
0640: 20 66 69 6c 65 73 20 61 72 65 20 6e 61 6d 65 64   files are named
0650: 20 73 74 61 72 74 69 6e 67 20 77 69 74 68 20 74   starting with t
0660: 68 69 73 20 70 72 65 66 69 78 20 66 6f 6c 6c 6f  his prefix follo
0670: 77 65 64 20 62 79 20 31 36 20 72 61 6e 64 6f 6d  wed by 16 random
0680: 0a 2a 2a 20 61 6c 70 68 61 6e 75 6d 65 72 69 63  .** alphanumeric
0690: 20 63 68 61 72 61 63 74 65 72 73 2c 20 61 6e 64   characters, and
06a0: 20 6e 6f 20 66 69 6c 65 20 65 78 74 65 6e 73 69   no file extensi
06b0: 6f 6e 2e 20 54 68 65 79 20 61 72 65 20 73 74 6f  on. They are sto
06c0: 72 65 64 20 69 6e 20 74 68 65 0a 2a 2a 20 4f 53  red in the.** OS
06d0: 27 73 20 73 74 61 6e 64 61 72 64 20 74 65 6d 70  's standard temp
06e0: 6f 72 61 72 79 20 66 69 6c 65 20 64 69 72 65 63  orary file direc
06f0: 74 6f 72 79 2c 20 61 6e 64 20 61 72 65 20 64 65  tory, and are de
0700: 6c 65 74 65 64 20 70 72 69 6f 72 20 74 6f 20 65  leted prior to e
0710: 78 69 74 2e 0a 2a 2a 20 49 66 20 73 71 6c 69 74  xit..** If sqlit
0720: 65 20 69 73 20 62 65 69 6e 67 20 65 6d 62 65 64  e is being embed
0730: 64 65 64 20 69 6e 20 61 6e 6f 74 68 65 72 20 70  ded in another p
0740: 72 6f 67 72 61 6d 2c 20 79 6f 75 20 6d 61 79 20  rogram, you may 
0750: 77 69 73 68 20 74 6f 20 63 68 61 6e 67 65 20 74  wish to change t
0760: 68 65 0a 2a 2a 20 70 72 65 66 69 78 20 74 6f 20  he.** prefix to 
0770: 72 65 66 6c 65 63 74 20 79 6f 75 72 20 70 72 6f  reflect your pro
0780: 67 72 61 6d 27 73 20 6e 61 6d 65 2c 20 73 6f 20  gram's name, so 
0790: 74 68 61 74 20 69 66 20 79 6f 75 72 20 70 72 6f  that if your pro
07a0: 67 72 61 6d 20 65 78 69 74 73 0a 2a 2a 20 70 72  gram exits.** pr
07b0: 65 6d 61 74 75 72 65 6c 79 2c 20 6f 6c 64 20 74  ematurely, old t
07c0: 65 6d 70 6f 72 61 72 79 20 66 69 6c 65 73 20 63  emporary files c
07d0: 61 6e 20 62 65 20 65 61 73 69 6c 79 20 69 64 65  an be easily ide
07e0: 6e 74 69 66 69 65 64 2e 20 54 68 69 73 20 63 61  ntified. This ca
07f0: 6e 20 62 65 20 64 6f 6e 65 0a 2a 2a 20 75 73 69  n be done.** usi
0800: 6e 67 20 2d 44 54 45 4d 50 5f 46 49 4c 45 5f 50  ng -DTEMP_FILE_P
0810: 52 45 46 49 58 3d 6d 79 70 72 65 66 69 78 5f 20  REFIX=myprefix_ 
0820: 6f 6e 20 74 68 65 20 63 6f 6d 70 69 6c 65 72 20  on the compiler 
0830: 63 6f 6d 6d 61 6e 64 20 6c 69 6e 65 2e 0a 2a 2f  command line..*/
0840: 0a 23 69 66 6e 64 65 66 20 54 45 4d 50 5f 46 49  .#ifndef TEMP_FI
0850: 4c 45 5f 50 52 45 46 49 58 0a 23 20 64 65 66 69  LE_PREFIX.# defi
0860: 6e 65 20 54 45 4d 50 5f 46 49 4c 45 5f 50 52 45  ne TEMP_FILE_PRE
0870: 46 49 58 20 22 73 71 6c 69 74 65 5f 22 0a 23 65  FIX "sqlite_".#e
0880: 6e 64 69 66 0a 0a 0a 0a 23 65 6e 64 69 66 20 2f  ndif....#endif /
0890: 2a 20 5f 53 51 4c 49 54 45 5f 4f 53 5f 48 5f 20  * _SQLITE_OS_H_ 
08a0: 2a 2f 0a                                         */.