4 files changed, 177 insertions, 22 deletions

diff --git a/admin/ChangeLog b/admin/ChangeLog
index d3bc51bd9f6..6d114eae003 100644
--- a/admin/ChangeLog
+++ b/admin/ChangeLog
@@ -1,3 +1,17 @@
+2010-10-12  Glenn Morris  <rgm@gnu.org>
+
+        * notes/nextstep: Move here from ../nextstep/DEV-NOTES.
+
+2010-10-09  Glenn Morris  <rgm@gnu.org>
+
+        * admin.el (set-version): Add doc/emacs/emacsver.texi.
+
+2010-10-09  Glenn Morris  <rgm@gnu.org>
+
+        * admin.el (set-version): No need to act on doc/ files any more.
+
+        * quick-install-emacs (PUBLIC_LIBSRC_BINARIES): Remove b2m.
+
 2010-09-05  Juanma Barranquero  <lekktu@gmail.com>
 
         * unidata/BidiMirroring.txt: Update from
diff --git a/admin/admin.el b/admin/admin.el
index 51bbecf4c57..7cd2c02fb58 100644
--- a/admin/admin.el
+++ b/admin/admin.el
@@ -1,7 +1,7 @@
 ;;; admin.el --- utilities for Emacs administration
 
-;; Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
-;;   Free Software Foundation, Inc.
+;; Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
+;;   2010  Free Software Foundation, Inc.
 
 ;; This file is part of GNU Emacs.
 
@@ -70,28 +70,13 @@ Root must be the root of an Emacs source tree."
                        (rx (and "AC_INIT" (1+ (not (in ?,)))
                                 ?, (0+ space)
                                 (submatch (1+ (in "0-9."))))))
-  (set-version-in-file root "doc/emacs/emacs.texi" version
+  (set-version-in-file root "doc/emacs/emacsver.texi" version
                        (rx (and "EMACSVER" (1+ space)
                                 (submatch (1+ (in "0-9."))))))
-  (set-version-in-file root "doc/lispref/elisp.texi" version
-                       (rx (and "EMACSVER" (1+ space)
-                                (submatch (1+ (in "0-9."))))))
-  (set-version-in-file root "doc/lispref/vol1.texi" version
-                       (rx (and "EMACSVER" (1+ space)
-                                (submatch (1+ (in "0-9."))))))
-  (set-version-in-file root "doc/lispref/vol2.texi" version
-                       (rx (and "EMACSVER" (1+ space)
-                                (submatch (1+ (in "0-9."))))))
-  (set-version-in-file root "doc/lispref/book-spine.texinfo" version
-                       (rx (and "Emacs Version" (1+ space)
-                                (submatch (1+ (in "0-9."))))))
   (set-version-in-file root "doc/man/emacs.1" version
                        (rx (and ".TH EMACS" (1+ not-newline)
                                 "GNU Emacs" (1+ space)
                                 (submatch (1+ (in "0-9."))))))
-  (set-version-in-file root "doc/misc/faq.texi" version
-                       (rx (and "VER" (1+ space)
-                                (submatch (1+ (in "0-9."))))))
   (set-version-in-file root "lib-src/makefile.w32-in" version
                        (rx (and "VERSION" (0+ space) "=" (0+ space)
                                 (submatch (1+ (in "0-9."))))))
@@ -218,5 +203,4 @@ Root must be the root of an Emacs source tree."
 
 (provide 'admin)
 
-;; arch-tag: 4ea83636-2293-408b-884e-ad64f22a3bf5
 ;;; admin.el ends here
diff --git a/admin/notes/nextstep b/admin/notes/nextstep
new file mode 100644
index 00000000000..462101f9abf
--- /dev/null
+++ b/admin/notes/nextstep
@@ -0,0 +1,159 @@
+This file summarizes primary aspects of the NS port architecture.  If
+possible, it should be updated for changes.
+
+Currently it summarizes the state as of:
+
+  summer 2008 shortly after merging to trunk
+
+
+
+Startup
+-------
+
+Init sequence:
+  emacs.c: ns_alloc_autorelease_pool()          nsterm.m
+  emacs.c: ns_init_paths()                      nsterm.m
+    - override EMACSLOADPATH, etc. so resources can be found in-bundle
+  emacs.c: init_display()                       dispnew.c
+    - sets Vwindow_system (window-system) to 'ns
+  emacs.c: loadup.el -> startup.el -> ns-initialize-window-system
+    -> x-open-connection (nsfns.m)
+      - ns-list-services
+      -> nsterm.m: ns_term_init()
+        - EmacsApp sharedApplication
+        - read NS defaults (org.gnu.Emacs.plist)
+        - init X-style color list
+        - ns_create_terminal()
+        - NSApp run (goes to applicationDidFinishLaunching which terminates
+                     event loop -- see below)
+
+
+
+Event Loop
+----------
+
+In an NS application, the event loop is normally managed by system and all
+user code is event-driven.  [NSApp run] is called by user and never returns.
+
+In Emacs, the event loop is managed by emacs itself.
+
+The NS port mediates between these two styles by intercepting the NS event
+dispatch at [NSApp sendEvent].  If a special event is detected, the event loop
+is broken, and control returned to Emacs.  This special event is sent by
+ns_send_appdefined, which is called under these circumstances:
+
+ - if a user input event is received
+ - when a timeout fires
+
+NS event processing is instigated from Emacs through ns_select() and
+ns_read_socket() in nsterm.m.  Parts of the codepaths leading to these
+functions are:
+
+
+ keyboard.c:read_avail_input()
+     -> ns_read_socket (ns_send_appdefined) -> [NSApp run]
+
+ process.c:wait_reading_process_output()
+     -> ns_select -> gobble_input (global inNsSelect=1)
+       -> ns_read_socket (ns_send_appdefined if !expected) -> [NSApp run]
+
+ sysdep.c:sys_select() -> read_input_waiting()
+     -> ns_read_socket (send_appdefined) -> [NSApp run]
+ [this codepath may not be used]
+
+
+Currently ctrl-g is not detected in as many circumstances as other emacsen.
+It is not certain whether this is due to the means of event loop integration,
+or errors of omission in the NS code.  This is an area for improvement.
+Also, see the article here and its containing thread:
+
+http://article.gmane.org/gmane.emacs.devel/92021/match=handling%5fsignal
+
+
+
+
+Text Rendering and Font Handling
+--------------------------------
+
+nsfont.m implements the font driver, responsible for managing fonts and
+rendering text.  Fonts are obtained through NSFontManager.  Rendering must be
+done at a low level due to emacs' fine control over this process, therefore
+there are different approachs under Cocoa and GNUstep.  Under GNUstep, the
+original NeXT Display PostScript (DPS) APIs are available and used.  Under
+Cocoa, these were removed and Quartz drawing functions replaced them.
+
+In both cases, font glyphs are accessed through UTF8 character
+representations.  It would be preferable to use unicode indices, but prior
+attempts at this have failed.
+
+Multi-script fontsets are auto-created in nsfont_make_fontset_for_font() using
+the facilities of NSTextStorage and NSLayoutManager.
+
+
+Object Architecture
+-------------------
+
+Unlike the other GUIs, the NS interface is based on a high-level and
+object-oriented API.  This creates some tension in the code because emacs
+itself has been architected around the low-level Xlib and Xt APIs.  The NS
+port tries to strike a balance between simplifying code on its side using OO
+features, and keeping code as similar as possible to other ports to ease
+maintenance.  The following are the main classes (see nsterm.h):
+
+EmacsApp : NSApplication
+  - event loop integration, interapp comms point for Finder (NSWorkspace) msgs,
+    Services
+  - one global instance (NSApp)
+  - nsterm.m
+
+EmacsView : NSView <TextInput>
+  - handles rendering of text and fringe, interapp comms for drag/drop
+  - instance for each frame
+  - child of window's content view
+  - nsterm.m
+
+EmacsWindow : NSWindow
+  - utility override for resize handling
+
+EmacsScroller : NSScroller
+  - instance for each emacs window, renders scrollbar
+  - child of window's content view
+  - nsterm.m
+
+EmacsImage : NSImage
+  - image rendering, toolbar icons, stippling, fringe bitmaps
+  - instance for each image
+  - nsimage.m
+
+EmacsMenu : NSMenu
+  - menu management
+  - one tree of instances for menubar, one instance for each popup menu
+  - nsmenu.m
+
+EmacsToolbar : NSToolbar
+  - toolbar management, one instance for each frame
+  - nsmenu.m
+
+
+EmacsDialogPanel : NSPanel
+  - popup dialogs, one instance for each
+  - nsmenu.m
+
+EmacsTooltip : NSObject
+  - tooltip popups, one instance for each
+  - nsmenu.m
+
+EmacsGlyphStorage : NSObject <NSGlyphStorage>
+  - utility for text rendering
+  - nsfont.m
+
+EmacsPrefsController : NSObject
+  - utility for preferences panel management, one global instance
+  - nsterm.m
+  - nextstep/Cocoa/Emacs.base/Contents/Resources/preferences.nib
+  - nextstep/GNUstep/Emacs.base/Resources/preferences.gorm
+
+EmacsSavePanel : NSSavePanel
+EmacsOpenPanel : NSOpenPanel
+  - utility override for panel notifications
+
diff --git a/admin/quick-install-emacs b/admin/quick-install-emacs
index 39b200b5102..24972e655b6 100755
--- a/admin/quick-install-emacs
+++ b/admin/quick-install-emacs
@@ -28,7 +28,7 @@
 ## install emacs very often.  See the --help output for more details.
 
 
-PUBLIC_LIBSRC_BINARIES='b2m emacsclient etags ctags ebrowse'
+PUBLIC_LIBSRC_BINARIES='emacsclient etags ctags ebrowse'
 PUBLIC_LIBSRC_SCRIPTS='grep-changelog rcs-checkin'
 
 AVOID="CVS -DIC README COPYING ChangeLog ~ [.]orig$ [.]rej$ Makefile$ Makefile.in$ makefile$ makefile.w32-in$ stamp-subdir [.]cvsignore [.]arch-ids [{]arch[}] [.][cho]$ make-docfile testfile test-distrib"
@@ -374,5 +374,3 @@ END {
 done
 
 ) | eval $EXEC
-
-# arch-tag: 9322b572-9755-4cf7-a67a-21e6505f1477