Compare commits

..

12 Commits

Author SHA1 Message Date
mlm
5403cc1fbd - Fix for recurring static variable (make it a member of the window group
structure)


git-svn-id: svn://10.0.0.236/branches/js_ops_BRANCH@1188 18797224-902f-48f8-a5cc-f745e15eee43
1998-05-06 20:16:14 +00:00
mlm
ea8b7ae403 Moving this file for js_ops_BRANCH
git-svn-id: svn://10.0.0.236/branches/js_ops_BRANCH@1187 18797224-902f-48f8-a5cc-f745e15eee43
1998-05-06 20:13:26 +00:00
mlm
792da6f338 - Replace thread safety fixes that I accidentally didn't check in when the
source tree moved to mozilla.

   - Make timeout globals thread-safe as part of the thread group object
   - Add LM locking to go with JS_BeginRequest stuff


git-svn-id: svn://10.0.0.236/branches/js_ops_BRANCH@1162 18797224-902f-48f8-a5cc-f745e15eee43
1998-05-05 22:26:12 +00:00
mlm
8f82414d4c Branch libpref for OPS new functionality for upcoming ns->moz renaming
git-svn-id: svn://10.0.0.236/branches/js_ops_BRANCH@635 18797224-902f-48f8-a5cc-f745e15eee43
1998-04-25 00:10:10 +00:00
mlm
ad93b6b9aa Branch libhook for OPS new functionality for upcoming ns->moz renaming
git-svn-id: svn://10.0.0.236/branches/js_ops_BRANCH@634 18797224-902f-48f8-a5cc-f745e15eee43
1998-04-25 00:09:11 +00:00
mlm
bf3132f22b Branch libparse for OPS new functionality for upcoming ns->moz renaming
git-svn-id: svn://10.0.0.236/branches/js_ops_BRANCH@633 18797224-902f-48f8-a5cc-f745e15eee43
1998-04-25 00:07:25 +00:00
mlm
66d0cd3091 Branch libnet for OPS new functionality for upcoming ns->moz renaming
git-svn-id: svn://10.0.0.236/branches/js_ops_BRANCH@631 18797224-902f-48f8-a5cc-f745e15eee43
1998-04-25 00:06:27 +00:00
mlm
d1186c4663 Branch libmocha for OPS new functionality for upcoming ns->moz renaming
git-svn-id: svn://10.0.0.236/branches/js_ops_BRANCH@630 18797224-902f-48f8-a5cc-f745e15eee43
1998-04-25 00:01:56 +00:00
mlm
6b1115ec03 Branch layout for OPS new functionality for upcoming ns->moz renaming
git-svn-id: svn://10.0.0.236/branches/js_ops_BRANCH@629 18797224-902f-48f8-a5cc-f745e15eee43
1998-04-24 23:43:28 +00:00
mlm
92c4bd320a Branch mozilla.mak for OPS new functionality for upcoming ns->moz renaming
git-svn-id: svn://10.0.0.236/branches/js_ops_BRANCH@628 18797224-902f-48f8-a5cc-f745e15eee43
1998-04-24 23:38:24 +00:00
mlm
f8c60c6777 Branch libevent for OPS new functionality for upcoming ns->moz renaming
git-svn-id: svn://10.0.0.236/branches/js_ops_BRANCH@627 18797224-902f-48f8-a5cc-f745e15eee43
1998-04-24 23:37:38 +00:00
(no author)
bc0482fed5 This commit was manufactured by cvs2svn to create branch 'js_ops_BRANCH'.
git-svn-id: svn://10.0.0.236/branches/js_ops_BRANCH@595 18797224-902f-48f8-a5cc-f745e15eee43
1998-04-24 07:21:02 +00:00
265 changed files with 44147 additions and 43583 deletions

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,62 @@
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* The contents of this file are subject to the Netscape Public License
* Version 1.0 (the "NPL"); you may not use this file except in
* compliance with the NPL. You may obtain a copy of the NPL at
* http://www.mozilla.org/NPL/
*
* Software distributed under the NPL is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
* for the specific language governing rights and limitations under the
* NPL.
*
* The Initial Developer of this code under the NPL is Netscape
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
* Reserved.
*/
/*
jscookie.h -- javascript reflection of cookies for filters.
Created: Frederick G.M. Roeber <roeber@netscape.com>, 12-Jul-97.
Adopted: Judson Valeski, 1997
*/
#ifndef _JSCOOKIE_H_
#define _JSCOOKIE_H_
typedef enum {
JSCF_accept,
JSCF_reject,
JSCF_ask,
JSCF_whatever,
JSCF_error
}
JSCFResult;
typedef struct {
char *path_from_header;
char *host_from_header;
char *name_from_header;
char *cookie_from_header;
time_t expires;
char *url;
Bool secure;
Bool domain;
Bool prompt; /* the preference */
NET_CookieBehaviorEnum preference;
}
JSCFCookieData;
extern JSCFResult JSCF_Execute(
MWContext *mwcontext,
const char *script_name,
JSCFCookieData *data,
Bool *data_changed
);
/* runs the garbage collector on the filter context. Probably a good
idea to call on completion of NET_GetURL or something. */
extern void JSCF_Cleanup(void);
#endif /* _JSCOOKIE_H_ */

755
mozilla/include/libevent.h Normal file
View File

@@ -0,0 +1,755 @@
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* The contents of this file are subject to the Netscape Public License
* Version 1.0 (the "NPL"); you may not use this file except in
* compliance with the NPL. You may obtain a copy of the NPL at
* http://www.mozilla.org/NPL/
*
* Software distributed under the NPL is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
* for the specific language governing rights and limitations under the
* NPL.
*
* The Initial Developer of this code under the NPL is Netscape
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
* Reserved.
*/
/*
* Header file for event passing between the mozilla thread and
* the mocha thread
*/
#ifndef libevent_h___
#define libevent_h___
#include "libmocha.h"
#include "prtypes.h"
#ifndef NSPR20
#include "prevent.h"
#else
#include "plevent.h"
#endif
#include "shist.h"
#include "fe_proto.h"
#include "lo_ele.h"
#include "jscookie.h"
NSPR_BEGIN_EXTERN_C
extern PREventQueue * mozilla_event_queue;
typedef struct WindowGroup LMWindowGroup;
/*
* XXX - should we use the same event values as layer events?
*/
/* Event bits stored in the low end of decoder->event_mask. */
#define EVENT_MOUSEDOWN 0x00000001
#define EVENT_MOUSEUP 0x00000002
#define EVENT_MOUSEOVER 0x00000004 /* user is mousing over a link */
#define EVENT_MOUSEOUT 0x00000008 /* user is mousing out of a link */
#define EVENT_MOUSEMOVE 0x00000010
#define EVENT_MOUSEDRAG 0x00000020
#define EVENT_CLICK 0x00000040 /* input element click in progress */
#define EVENT_DBLCLICK 0x00000080
#define EVENT_KEYDOWN 0x00000100
#define EVENT_KEYUP 0x00000200
#define EVENT_KEYPRESS 0x00000400
#define EVENT_DRAGDROP 0x00000800 /* not yet implemented */
#define EVENT_FOCUS 0x00001000 /* input focus event in progress */
#define EVENT_BLUR 0x00002000 /* loss of focus event in progress */
#define EVENT_SELECT 0x00004000 /* input field selection in progress */
#define EVENT_CHANGE 0x00008000 /* field value change in progress */
#define EVENT_RESET 0x00010000 /* form submit in progress */
#define EVENT_SUBMIT 0x00020000 /* form submit in progress */
#define EVENT_SCROLL 0x00040000 /* window is being scrolled */
#define EVENT_LOAD 0x00080000 /* layout parsed a loaded document */
#define EVENT_UNLOAD 0x00100000
#define EVENT_XFER_DONE 0x00200000 /* document has loaded */
#define EVENT_ABORT 0x00400000
#define EVENT_ERROR 0x00800000
#define EVENT_LOCATE 0x01000000
#define EVENT_MOVE 0x02000000
#define EVENT_RESIZE 0x04000000
#define EVENT_FORWARD 0x08000000
#define EVENT_HELP 0x10000000 /* for handling of help events */
#define EVENT_BACK 0x20000000
/* #define EVENT_PRINT 0x20000000 *//* To be removed per joki */
#define STATUS_STOP 0x00000001 /* stop processing */
#define STATUS_IGNORE 0x00000002 /* no new messages */
#define EVENT_ALT_MASK 0x00000001
#define EVENT_CONTROL_MASK 0x00000002
#define EVENT_SHIFT_MASK 0x00000004
#define EVENT_META_MASK 0x00000008
#define ARGTYPE_NULL 0x00000001
#define ARGTYPE_INT32 0x00000002
#define ARGTYPE_BOOL 0x00000004
#define ARGTYPE_STRING 0x00000008
#define SIZE_MAX 0x00000001
#define SIZE_MIN 0X00000002
/*
* When the event has been processed by the backend, there will be
* a front-end callback that gets called. If the event processed
* successfully, the callback will be passed EVENT_OK. If the
* event wasn't successful (i.e. the user canceled it) the return
* status will be EVENT_CANCEL. If something radical happened
* and the front-end should do nothing (i.e. mocha changed the
* underlying context) the status will be EVENT_PANIC and the
* front end should treat the context and element passed to the
* exit routine as bogus
*/
typedef enum {
EVENT_OK,
EVENT_CANCEL,
EVENT_PANIC
} ETEventStatus;
/*
* When a given event gets processed we may need to tell the front
* end about it so that they can update the UI / continue the
* operation. The context, lo_element, lType and whatever
* field are all supplied by the original ET_SendEvent() call.
* See ET_SendEvent() for a description of the values for
* the status parameter
*/
typedef void
(*ETClosureFunc)(MWContext * pContext, LO_Element * lo_element,
int32 lType, void * whatever, ETEventStatus status);
/*
* Someone has initiated a call to LM_EvaluateBuffer(). This function
* gets called back with the result
*/
typedef void
(*ETEvalAckFunc)(void * data, char * result_string, size_t result_length,
char * wysiwyg_url, char * base_href, Bool valid);
/*
* This function is called back after a layer's state has been restored
* in a resize_relayout.
*/
typedef void
(*ETRestoreAckFunc)(void * data, LO_BlockInitializeStruct *param);
/*
* Typedef for a function taking a void pointer and
* returning nothing
*/
typedef void
(*ETVoidPtrFunc)(void * data);
/*
* Typedef for a function taking a void pointer and
* returning a bool
*/
typedef PRBool
(*ETBoolPtrFunc)(void * data);
/*
* Typedef for a function taking a void pointer and
* returning a int32
*/
typedef int32
(*ETIntPtrFunc)(void * data);
/*
* Typedef for a function taking a void pointer and
* returning a char *
*/
typedef char *
(*ETStringPtrFunc)(void * data);
/*
* Struct for passing JS typed variable info through C interface calls
*/
typedef union ArgVal {
int32 intArg;
XP_Bool boolArg;
char * stringArg;
} ArgVal;
typedef struct {
uint8 type; /* arg type as defined at top of file */
ArgVal value;
} JSCompArg;
/*
* Typedef for a function used to verify installed components and
* get back components utility functions.
*/
typedef PRBool
(*ETVerifyComponentFunc)(void **active_callback, void **startup_callback);
/*
* Generic function for JS setting values with native calls.
*/
typedef void
(*ETCompPropSetterFunc)(char *name, void *value);
/*
* Generic function for JS getting values from native calls.
*/
typedef void*
(*ETCompPropGetterFunc)(char *name);
/*
* Generic function for JS calling native methods.
*/
typedef void*
(*ETCompMethodFunc)(int32 argc, JSCompArg *argv);
/* --------------------------------------------------------------------------
* Common prologue for talking between the mocha thread and the mozilla
* thread
*/
typedef struct {
PREvent event; /* the PREvent structure */
MWContext* context; /* context */
int32 doc_id; /* doc id of context when event launched */
PRPackedBool handle_eagerly;
} ETEvent;
/*
* Struct to send back from front end in order to get additional
* event information without having to initialize event object
* until necessary. Yow, there is a lot of junk in here now
* can we make a union out of some of these or are they always
* needed?
*/
typedef struct {
ETEvent ce;
MochaDecoder * decoder;
JSObject * object;
int32 type;
int32 layer_id;
int32 id;
LO_Element * lo_element;
ETClosureFunc fnClosure; /* event sender closure */
void * whatever; /* anything other state */
int32 x,y;
int32 docx,docy;
int32 screenx,screeny;
uint32 which;
uint32 modifiers;
void * data;
uint32 dataSize;
PRPackedBool saved;
PRPackedBool event_handled;
} JSEvent;
/*
* Tell the backend about a new event.
* The event is placed onto an event queue, it is not processed
* immediately. If the event is the type that can be cancelled
* by the backend (i.e. a button click or a submit) the front
* end must wait until the callback routine gets called before
* continuing with the operation. The ETEventStatus will be
* EVENT_OK if the operation is to continue or EVENT_CANCEL
* if it got cancelled.
*
* The processing of the event may cause the document to change
* or even the whole window to close. In those cases the callback
* will still get called in case there is any front-end cleanup
* to do but the ETEventStatus will be set to EVENT_PANIC
*
*/
extern JSBool
ET_SendEvent(MWContext * pContext, LO_Element *pElement, JSEvent *pEvent,
ETClosureFunc fnClosure, void * whatever);
/*
* Tell the backend about a new document load event. We need a
* closure so that libparse/layout knows when its safe to discard
* the old document when they were waiting for onunload events to
* finish processing
*/
extern void
ET_SendLoadEvent(MWContext * pContext, int32 type, ETVoidPtrFunc fnClosure,
NET_StreamClass *stream, int32 layer_id, Bool resize_reload);
/*
* Tell the backend about a new image event. Async. No closure
*/
extern void
ET_SendImageEvent(MWContext * pContext, LO_ImageStruct *image_data,
LM_ImageEvent event);
/*
* Send an interrupt event to the current context
* Remove all pending events for the event queue of the given context.
*/
extern void
ET_InterruptContext(MWContext * pContext);
extern JSBool
ET_ContinueProcessing(MWContext * pContext);
/*
* Tell mocha to destroy the given context's data. The callback
* function gets called when mocha is done with all of its data
* that was associated with the context
*/
extern void
ET_RemoveWindowContext(MWContext * context, ETVoidPtrFunc fn,
void * data);
typedef struct {
uint len, line_no;
char * scope_to;
void * data;
JSVersion version;
JSPrincipals * principals;
JSBool want_result;
JSBool unicode;
} ETEvalStuff;
/*
* Evaluate the mocha code in the given buffer
*/
extern void
ET_EvaluateBuffer(MWContext * context, char * buffer, uint buflen,
uint line_no, char * scope_to, JSBool want_result,
ETEvalAckFunc fn, void * data,
JSVersion ver, struct JSPrincipals *);
extern void
ET_EvaluateScript(MWContext * context, char * buffer, ETEvalStuff * stuff,
ETEvalAckFunc fn);
/*
* Ask Mocha to reflect the given object into JavaScript
*/
extern void
ET_ReflectObject(MWContext * pContext, void * lo_ele, void * tag,
int32 layer_id, uint index, ReflectedObject type);
void
ET_ReflectFormElement(MWContext * pContext, void * form,
LO_FormElementStruct * form_element, PA_Tag * tag);
extern void
ET_ReflectWindow(MWContext * pContext,
PA_Block onLoad, PA_Block onUnload,
PA_Block onFocus, PA_Block onBlur, PA_Block onHelp,
PA_Block onMouseOver, PA_Block onMouseOut, PA_Block onDragDrop,
PA_Block onMove, PA_Block onResize,
PA_Block id, char *all,
Bool bDelete, int newline_count);
/*
* Tell mocha we are processing a form
*/
extern void
ET_SetActiveForm(MWContext * pContext, struct lo_FormData_struct * loElement);
/*
* Tell mocha which layer we are processing
*/
void
ET_SetActiveLayer(MWContext * pContext, int32 layer_id);
/*
** Tell mocha where to send its output
*/
extern void
ET_ClearDecoderStream(MWContext * context, NET_StreamClass * old_stream);
extern void
ET_SetDecoderStream(MWContext * context, NET_StreamClass *stream,
URL_Struct *url_struct, JSBool free_stream_on_close);
/*
** Remember the current nesting URL in the MochaDecoder
*/
extern void
ET_SetNestingUrl(MWContext * context, char * szUrl);
/*
** Remember the current language version in the MochaDecoder
*/
extern void
ET_SetVersion(MWContext * context, JSVersion version);
/*
* Tell mocha to trash the current document. around and around...
*/
extern void
ET_ReleaseDocument(MWContext * pContext, JSBool resize_reload);
/*
* Tell mocha to trash the layer's document.
*/
extern void
ET_DestroyLayer(MWContext * pContext, JSObject *layer_obj);
extern void
ET_MochaStreamComplete(MWContext * context, void * buf, int len,
char * content_type, Bool isUnicode);
extern void
ET_MochaStreamAbort(MWContext * context, int status);
/*
* Called when a layer's contents are changing and we want to create
* a new layer document.
*/
extern void
ET_NewLayerDocument(MWContext *pContext, int32 layer_id);
extern void
ET_DocWriteAck(MWContext *pContext, int status);
extern void
ET_RegisterComponent(char *name, void *active_callback, void *startup_callback);
extern void
ET_RegisterComponentProp(char *comp, char *name, uint8 retType, void *setter,
void *getter);
extern void
ET_RegisterComponentMethod(char *comp, char *name, uint8 retType, void *method,
int32 argc);
/* =============================================================== */
/*
* This event can be sent to both the mozilla thread and the moacha thread
*/
typedef struct {
ETEvent ce;
TimeoutCallbackFunction fnCallback;
void* pClosure;
uint32 ulTime;
void* pTimerId;
} MozillaEvent_Timeout;
/* =============================================================== */
/*
* Busy loop waiting for events to come along
*/
extern void PR_CALLBACK
lm_wait_for_events(void *);
/*
* global mocha event queues. It would be nice to not have these
* exported this globally
*/
extern PREventQueue *lm_InterpretQueue;
extern PREventQueue *lm_PriorityQueue;
/*
* Ways to send events to the front end
*/
extern JSBool
ET_PostMessageBox(MWContext* context, char* szMessage,
JSBool bConfirm);
extern void
ET_PostProgress(MWContext* context, const char* szMessage);
/* --- timeout routines --- */
/*
* Set (or clear) a timeout to go off. The timeout will go off in the
* mozilla thread so we will use the routine ET_FireTimeoutCallBack()
* to get back into our thread to actually run the closure
*/
extern void *
ET_PostSetTimeout(TimeoutCallbackFunction fnCallback,
void * pClosure, uint32 ulTime, int32 doc_id);
extern void
ET_PostClearTimeout(void * stuff);
extern void
ET_FireTimeoutCallBack(void *);
/* --- end of timeout routines --- */
extern void
ET_PostDestroyWindow(MWContext * context);
extern void
ET_PostManipulateForm(MWContext * context, LO_Element * pForm, int32 action);
extern void
ET_PostClearView(MWContext * context);
extern void
ET_PostFreeImageElement(MWContext * context, void * stuff);
extern void
ET_PostFreeImageContext(MWContext *context, IL_GroupContext *img_cx);
extern void
ET_PostFreeAnonImages(MWContext *context, IL_GroupContext *img_cx);
extern void
ET_PostDisplayImage(MWContext *, int, LO_ImageStruct *);
extern void
ET_PostGetUrl(MWContext *, URL_Struct * pUrl);
extern char *
ET_PostPrompt(MWContext* context, const char* szMessage,
const char * szDefault);
extern MWContext *
ET_PostNewWindow(MWContext* context, URL_Struct * pUrl,
char * szName, Chrome * pChrome, LMWindowGroup *grp);
extern void
ET_PostUpdateChrome(MWContext* context, Chrome * pChrome);
extern void
ET_PostQueryChrome(MWContext* context, Chrome * pChrome);
extern void
ET_PostGetScreenSize(MWContext* context, int32 *pX, int32 *pY);
extern void
ET_PostGetAvailScreenRect(MWContext* context, int32 *pX, int32 *pY,
int32 *pLeft, int32 *pTop);
extern void
ET_PostGetColorDepth(MWContext* context, int32 *pPixel, int32 *pPallette);
extern char *
ET_PostGetSelectedText(MWContext* context);
extern void
ET_PostScrollDocTo(MWContext* context, int loc, int32 x, int32 y);
extern void
ET_PostScrollDocBy(MWContext* context, int loc, int32 x, int32 y);
extern void
ET_PostBackCommand(MWContext* context);
extern void
ET_PostForwardCommand(MWContext* context);
extern void
ET_PostHomeCommand(MWContext* context);
extern JSBool
ET_PostFindCommand(MWContext* context, char * szName, JSBool matchCase,
JSBool searchBackward);
extern void
ET_PostPrintCommand(MWContext* context);
extern void
ET_PostOpenFileCommand(MWContext* context);
extern void
ET_MakeHTMLAlert(MWContext * context, const char * szString);
/* respond to events sent to the mocha thread by the mozilla thread */
extern void
ET_PostJsEventAck(MWContext* context, LO_Element * pEle, int type,
ETClosureFunc fnClosure, void * pStuff,
ETEventStatus status);
extern void
ET_PostEvalAck(MWContext * context, int doc_id, void * data,
char * str, size_t len, char * wysiwyg_url,
char * base_href, Bool valid, ETEvalAckFunc fn);
extern void
ET_PostRestoreAck(void *data, LO_BlockInitializeStruct *param,
ETRestoreAckFunc fn);
/* netlib events */
extern char *
ET_net_GetCookie(MWContext* context, int32 doc_id);
extern char *
ET_net_SetCookieString(MWContext* context, char * szCookie, int32 doc_id);
extern NET_StreamClass *
ET_net_CacheConverter(FO_Present_Types format, void * obj,
URL_Struct *pUrl, MWContext * pContext);
extern void
ET_net_FindURLInCache(URL_Struct * pUrl, MWContext * pContext);
extern NET_StreamClass *
ET_net_StreamBuilder(FO_Present_Types format, URL_Struct *pUrl,
MWContext * pContext);
/* layout events */
extern void
ET_lo_ResetForm(MWContext * pContext, LO_Element * ele);
void
ET_fe_SubmitInputElement(MWContext * pContext, LO_Element * ele);
/*
* Synchronously shove the given text down the parser's processing
* queue. If the currently loaded document is not equal to
* doc_id, this message should be ignored since it arrived too
* late for the intended document
*/
extern int
ET_lo_DoDocWrite(JSContext *cx, MWContext * context, NET_StreamClass * stream,
char * str, size_t len, int32 doc_id);
extern void
ET_il_GetImage(const char * str, MWContext * pContext, IL_GroupContext *img_cx,
LO_ImageStruct * image_data, NET_ReloadMethod how);
extern void
ET_il_SetGroupObserver(MWContext * pContext, IL_GroupContext *pImgCX, void *pDpyCX,
JSBool bAddObserver);
extern void
ET_InterruptImgCX(MWContext * pContext);
/*
* Tell layout to trash the current document.
*/
extern void
ET_lo_DiscardDocument(MWContext * pContext);
/*
* Tell layout to prepare a layer for writing.
*/
extern Bool
ET_lo_PrepareLayerForWriting(MWContext *context, int32 layer_id,
const char *referer);
/*
* Return a copy of the current history element. Caller must free
*/
extern History_entry *
ET_shist_GetCurrent(MWContext * pContext);
/*
* Return the current security status.
*/
extern int
ET_GetSecurityStatus(MWContext * pContext);
/*
* Make sure Mocha/Java glue is ready. Returns the same return code as
* LM_InitMoja.
*/
extern int
ET_InitMoja(MWContext * pContext);
/*
* Pack up toys and go home
*/
extern void
ET_FinishMocha(void);
/*
* Used to call a stream completion function in the mozilla
* thread
*/
extern void
ET_moz_CallFunction(ETVoidPtrFunc fn, void * data);
extern void
ET_moz_CallFunctionAsync(ETVoidPtrFunc fn, void * data);
extern PRBool
ET_moz_CallFunctionBool(ETBoolPtrFunc fn, void * data);
extern int32
ET_moz_CallFunctionInt(ETIntPtrFunc fn, void * data);
extern char *
ET_moz_CallFunctionString(ETStringPtrFunc fn, void * data);
extern void
ET_moz_CallAsyncAndSubEventLoop(ETVoidPtrFunc fn, void *data,
MWContext *context);
extern void
ET_moz_Abort(MKStreamAbortFunc fn, void * data, int status);
extern void
ET_moz_SetMochaWriteStream(MochaDecoder * decoder);
extern NET_StreamClass *
ET_moz_DocCacheConverter(MWContext * context, URL_Struct * pUrl,
char * wysiwyg_url, int32 layer_id);
extern PRBool
ET_moz_VerifyComponentFunction(ETVerifyComponentFunc fn, ETBoolPtrFunc *pActive_callback,
ETVoidPtrFunc *pStartup_callback);
extern void
ET_moz_CompSetterFunction(ETCompPropSetterFunc fn, char *name, void *data);
extern void *
ET_moz_CompGetterFunction(ETCompPropGetterFunc fn, char *name);
extern void *
ET_moz_CompMethodFunction(ETCompMethodFunc fn, int32 argc, JSCompArg *argv);
typedef enum {
CL_Move,
CL_MoveX,
CL_MoveY,
CL_Offset,
CL_Resize,
CL_SetBboxWidth,
CL_SetBboxHeight,
CL_SetBboxTop,
CL_SetBboxLeft,
CL_SetBboxBottom,
CL_SetBboxRight,
CL_SetHidden,
CL_MoveInZ,
CL_SetSrc,
CL_SetSrcWidth,
CL_SetZ,
CL_SetBgColor,
CL_SetBackdrop
} ETLayerOp;
extern int
ET_TweakLayer(MWContext * context, CL_Layer * layer, int32 x, int32 y,
void *param_ptr, int32 param_val, ETLayerOp op,
const char *referer, int32 doc_id);
extern void
ET_RestoreLayerState(MWContext *context, int32 layer_id,
LO_BlockInitializeStruct *param, ETRestoreAckFunc fn,
void *data);
extern int32
ET_npl_RefreshPluginList(MWContext* context, XP_Bool refreshInstances);
extern JSCFResult
ET_JSCFExecute(MWContext *context, const char *script_name,
JSCFCookieData *data, Bool *data_changed);
extern JSBool
ET_HandlePref(JSContext * cx, uint argc, jsval * argv, jsval * rval);
extern void
ET_SetPluginWindow(MWContext * pContext, void * app);
NSPR_END_EXTERN_C
#endif /* libevent_h___ */

546
mozilla/include/libmocha.h Normal file
View File

@@ -0,0 +1,546 @@
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* The contents of this file are subject to the Netscape Public License
* Version 1.0 (the "NPL"); you may not use this file except in
* compliance with the NPL. You may obtain a copy of the NPL at
* http://www.mozilla.org/NPL/
*
* Software distributed under the NPL is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
* for the specific language governing rights and limitations under the
* NPL.
*
* The Initial Developer of this code under the NPL is Netscape
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
* Reserved.
*/
/*
* Header file for Mocha in the Navigator (libmocha).
*/
#ifndef libmocha_h___
#define libmocha_h___
#include "ntypes.h"
#include "il_types.h"
#include "prtypes.h"
#include "plhash.h"
#include "prthread.h"
#include "jsapi.h"
/* enable JavaScript Debugger support */
#if defined (_WIN32) || defined(XP_UNIX) || defined(powerc) || defined(__powerc) || defined(XP_OS2)
#ifdef JAVA
#define JSDEBUGGER 1
#endif
#endif
NSPR_BEGIN_EXTERN_C
typedef struct JSTimeout JSTimeout;
typedef struct JSPrincipalsList JSPrincipalsList;
typedef struct JSNestingUrl JSNestingUrl;
/*
* There exists one MochaDecoder per top-level MWContext that decodes Mocha,
* either from an HTML page or from a "mocha:[expr]" URL.
*/
typedef struct MochaDecoder {
int32 forw_count; /* forward reference count */
int32 back_count; /* back (up the tree) count */
JSContext *js_context;
MWContext *window_context;
JSObject *window_object;
NET_StreamClass *stream;
int32 stream_owner; /* id of layer that's loading the stream */
URL_Struct *url_struct;
JSTimeout *timeouts;
JSTimeout *saved_timeouts;
uint16 signature_ordinal;
PRPackedBool replace_location;
PRPackedBool resize_reload;
PRPackedBool load_event_sent;
PRPackedBool visited;
PRPackedBool writing_input;
PRPackedBool free_stream_on_close;
PRPackedBool in_window_quota;
PRPackedBool called_win_close;
PRPackedBool principals_compromised;
const char *source_url;
JSNestingUrl *nesting_url;
uint32 error_count;
uint32 event_mask;
int32 active_layer_id;
uint32 active_form_id;
uint32 event_bit;
int32 doc_id;
/*
* Class prototype objects, in alphabetical order. Must be CLEARed (set
* to null) in LM_PutMochaDecoder, HELD (GC roots added) in lm_NewWindow,
* and DROPped (removed as GC roots) in lm_DestroyWindow.
* XXXbe clean up, clear via bzero, using a sub-structure.
*/
JSObject *anchor_prototype;
JSObject *bar_prototype;
JSObject *document_prototype;
JSObject *event_prototype;
JSObject *event_capturer_prototype;
JSObject *event_receiver_prototype;
JSObject *form_prototype;
JSObject *image_prototype;
JSObject *input_prototype;
JSObject *layer_prototype;
JSObject *option_prototype;
JSObject *rect_prototype;
JSObject *url_prototype;
/*
* Window sub-objects. These must also follow the CLEAR/HOLD/DROP
* protocol mentioned above.
*/
JSObject *document;
JSObject *history;
JSObject *location;
JSObject *navigator;
JSObject *components;
JSObject *screen;
JSObject *hardware;
JSObject *crypto;
JSObject *pkcs11;
/*
* Ad-hoc GC roots.
*/
JSObject *event_receiver;
JSObject *opener;
JSVersion firstVersion; /* First JS script tag version. */
/*
* Security info for all of this decoder's scripts, except those
* contained in layers.
*/
JSPrincipals *principals;
JSPrincipalsList*early_access_list;
IL_GroupContext *image_context; /* Image context for anonymous images */
/*
* Table that maintains an id to JS object mapping for reflected
* elements. This is used during resize to reestablish the connection
* between layout elements and their corresponding JS object.
* Form elements are special, since they can't use the same keying
*/
PRHashTable *id_to_object_map;
} MochaDecoder;
/*
* Number of buckets for the id-to-object hash table.
*/
#define LM_ID_TO_OBJ_MAP_SIZE 20
#define LM_FORM_ELEMENT_MAP_SIZE 10
/*
* Types of objects reflected into Mocha
*/
typedef enum {
LM_APPLETS = 0,
LM_FORMS,
LM_LINKS,
LM_NAMEDANCHORS,
LM_EMBEDS,
LM_IMAGES,
LM_FORMELEMENTS,
LM_LAYERS
} ReflectedObject;
/*
* Generates an id-to-object mapping key from the ReflectedObject
* type, the containing layer id and the id of the object itself.
* The key is 4 bits type, 14 bits layer_id and 14 bits id.
*/
#define LM_GET_MAPPING_KEY(obj_type, layer_id, id) \
(void *)(((((uint32)obj_type) << 28) & 0xF0000000UL) | \
((((uint32)layer_id) << 14) & 0x0FFFC000UL) | \
(((uint32)id) & 0x00003FFFUL))
/*
* Public, well-known string constants.
*/
extern char js_language_name[]; /* "JavaScript" */
extern char js_content_type[]; /* "application/x-javascript" */
/*
* Initialize and finalize Mocha-in-the-client.
*/
extern void LM_InitMocha(void);
extern void LM_FinishMocha(void);
/*
* Force mocha on in the given context, even if the user pref is set to
* disable mocha.
*/
extern void LM_ForceJSEnabled(MWContext *cx);
/*
* Initialize and finalize Mocha-Java connection
*/
#define LM_MOJA_UNINITIALIZED 0
#define LM_MOJA_OK 1
#define LM_MOJA_JAVA_FAILED 2
#define LM_MOJA_OUT_OF_MEMORY 3
extern int LM_InitMoja(void);
extern void LM_FinishMoja(void);
extern int LM_IsMojaInitialized(void);
/*
* Enter or leave the big mocha lock. Any thread which wants to
* preserve JavaScript run-to-completion semantics must bracket
* JavaScript evaluation with these calls.
*/
typedef void
(PR_CALLBACK *JSLockReleaseFunc)(void * data);
extern void PR_CALLBACK LM_LockJS(MWContext *mwc);
extern void PR_CALLBACK LM_UnlockJS(MWContext *mwc);
extern JSBool PR_CALLBACK LM_AttemptLockJS(MWContext *mwc,
JSLockReleaseFunc fn, void * data);
extern JSBool PR_CALLBACK LM_ClearAttemptLockJS(MWContext *mwc,
JSLockReleaseFunc fn,
void * data);
extern PRBool PR_CALLBACK
LM_HandOffJSLock(PRThread * oldOwner, PRThread *newOwner);
/*
* For interruption purposes we will sometimes need to know the
* context who is holding the JS lock
*/
extern void LM_JSLockSetContext(MWContext * context);
extern MWContext * LM_JSLockGetContext(MWContext *mwc);
/*
* Enable/disable for Mocha-in-the-client.
*/
#define LM_SwitchMocha(toggle) LM_SetMochaEnabled(toggle)
extern JSBool
LM_GetMochaEnabled(void);
/*
* Get (create if necessary) a MochaDecoder for context, adding a reference
* to its window_object. Put drops the reference, destroying window_object
* when the count reaches zero. These functions should only be called in
* the mocha thread or while holding the JS-lock
*/
extern MochaDecoder *
LM_GetMochaDecoder(MWContext *context);
extern void
LM_PutMochaDecoder(MochaDecoder *decoder);
/*
* Get the source URL for script being loaded by document. This URL will be
* the document's URL for inline script, or the SRC= URL for included script.
* The returned pointer is safe only within the extent of the function that
* calls LM_GetSourceURL().
*/
extern const char *
LM_GetSourceURL(MochaDecoder *decoder);
/*
* Set the current layer and hence the current scope for script evaluation.
*/
extern void
LM_SetActiveLayer(MWContext * context, int32 layer_id);
/*
* Get the current layer and hence the current scope for script evaluation.
*/
extern int32
LM_GetActiveLayer(MWContext * context);
/*
* Evaluate the contents of a SCRIPT tag. You can specify the JSObject
* to use as the base scope. Pass NULL to use the default window_object
*/
extern JSBool
LM_EvaluateBuffer(MochaDecoder *decoder, void *base, size_t length,
uint lineno, char * scope_to, struct JSPrincipals *principals,
JSBool unicode, jsval *result);
/*
* Evaluate an expression entity in an HTML attribute (WIDTH="&{height/2};").
* Returns null on error, otherwise a pointer to the malloc'd string result.
* The caller is responsible for freeing the string result.
*/
extern char *
LM_EvaluateAttribute(MWContext *context, char *expr, uint lineno);
/*
* Remove any MochaDecoder window_context pointer to an MWContext that's
* being destroyed.
*/
extern void
LM_RemoveWindowContext(MWContext *context, History_entry * he);
extern void
LM_DropSavedWindow(MWContext *context, void *window);
/*
* Set and clear the HTML stream and URL for the MochaDecoder
* associated with the given context
*/
extern JSBool
LM_SetDecoderStream(MWContext * context, NET_StreamClass *stream,
URL_Struct *url_struct, JSBool free_stream_on_close);
/*
* Start caching HTML or plain text generated by document.write() where the
* script is running on mc, the document is being generated into decoder's
* window, and url_struct tells about the generator.
*/
extern NET_StreamClass *
LM_WysiwygCacheConverter(MWContext *context, URL_Struct *url_struct,
const char * wysiwyg_url, const char * base_href);
/*
* Skip over the "wysiwyg://docid/" in url_string and return a pointer to the
* real URL hidden after the prefix. If url_string is not of "wysiwyg:" type,
* just return url_string. Never returns null.
*/
extern const char *
LM_StripWysiwygURLPrefix(const char *url_string);
/*
* This function works only on "wysiwyg:" type URLs -- don't call it unless
* you know that NET_URL_Type(url_string) is WYSIWYG_TYPE_URL. It'll return
* null if url_string seems too short, or if it can't find the third slash.
*/
extern const char *
LM_SkipWysiwygURLPrefix(const char *url_string);
/*
* Return a pointer to a malloc'd string of the form "<BASE HREF=...>" where
* the "..." URL is the directory of cx's origin URL. Such a base URL is the
* default base for relative URLs in generated HTML.
*/
extern char *
LM_GetBaseHrefTag(JSContext *cx, JSPrincipals *principals);
/*
* XXX Make these public LO_... typedefs in lo_ele.h/ntypes.h?
*/
struct lo_FormData_struct;
struct lo_NameList_struct;
extern struct lo_FormData_struct *
LO_GetFormDataByID(MWContext *context, int32 layer_id, intn form_id);
extern uint
LO_EnumerateForms(MWContext *context, int32 layer_id);
extern struct LO_ImageStruct_struct *
LO_GetImageByIndex(MWContext *context, int32 layer_id, intn image_id);
extern uint
LO_EnumerateImages(MWContext *context, int32 layer_id);
/*
* Reflect display layers into Mocha.
*/
extern JSObject *
LM_ReflectLayer(MWContext *context, int32 layer_id, int32 parent_layer_id,
PA_Tag *tag);
extern LO_FormElementStruct *
LO_GetFormElementByIndex(struct lo_FormData_struct *form_data, int32 index);
extern uint
LO_EnumerateFormElements(MWContext *context,
struct lo_FormData_struct *form_data);
/*
* Layout helper function to find a named anchor by its index in the
* document.anchors[] array.
*/
extern struct lo_NameList_struct *
LO_GetNamedAnchorByIndex(MWContext *context, int32 layer_id, uint index);
extern uint
LO_EnumerateNamedAnchors(MWContext *context, int32 layer_id);
/*
* Layout Mocha helper function to find an HREF Anchor by its index in the
* document.links[] array.
*/
extern LO_AnchorData *
LO_GetLinkByIndex(MWContext *context, int32 layer_id, uint index);
extern uint
LO_EnumerateLinks(MWContext *context, int32 layer_id);
extern LO_JavaAppStruct *
LO_GetAppletByIndex(MWContext *context, int32 layer_id, uint index);
extern uint
LO_EnumerateApplets(MWContext *context, int32 layer_id);
extern LO_EmbedStruct *
LO_GetEmbedByIndex(MWContext *context, int32 layer_id, uint index);
extern uint
LO_EnumerateEmbeds(MWContext *context, int32 layer_id);
/*
* Get and set a color attribute in the current document state.
*/
extern void
LO_GetDocumentColor(MWContext *context, int type, LO_Color *color);
extern void
LO_SetDocumentColor(MWContext *context, int type, LO_Color *color);
/*
* Layout function to reallocate the lo_FormElementOptionData array pointed at
* by lo_FormElementSelectData's options member to include space for the number
* of options given by selectData->option_cnt.
*/
extern XP_Bool
LO_ResizeSelectOptions(lo_FormElementSelectData *selectData);
/*
* Discard the current document and all its subsidiary objects.
*/
extern void
LM_ReleaseDocument(MWContext *context, JSBool resize_reload);
/*
* Search if a the event is being captured in the frame hierarchy.
*/
extern XP_Bool
LM_EventCaptureCheck(MWContext *context, uint32 current_event);
/*
* Scroll a window to the given point.
*/
extern void LM_SendOnScroll(MWContext *context, int32 x, int32 y);
/*
* Display a help topic.
*/
extern void LM_SendOnHelp(MWContext *context);
/*
* Send a load or abort event for an image to a callback.
*/
typedef enum LM_ImageEvent {
LM_IMGUNBLOCK = 0,
LM_IMGLOAD = 1,
LM_IMGABORT = 2,
LM_IMGERROR = 3,
LM_LASTEVENT = 3
} LM_ImageEvent;
extern void
LM_ProcessImageEvent(MWContext *context, LO_ImageStruct *image_data,
LM_ImageEvent event);
/* This should be called when a named anchor is located. */
extern JSBool
LM_SendOnLocate(MWContext *context, struct lo_NameList_struct *name_rec);
extern JSObject *
LM_ReflectApplet(MWContext *context, LO_JavaAppStruct *applet_data,
PA_Tag * tag, int32 layer_id, uint index);
extern JSObject *
LM_ReflectEmbed(MWContext *context, LO_EmbedStruct *lo_embed,
PA_Tag * tag, int32 layer_id, uint index);
struct lo_FormData_struct;
struct lo_NameList_struct;
extern JSObject *
LM_ReflectForm(MWContext *context, struct lo_FormData_struct *form_data,
PA_Tag * tag, int32 layer_id, uint index);
extern JSObject *
LM_ReflectFormElement(MWContext *context, int32 layer_id, int32 form_id,
int32 element_id, PA_Tag * tag);
extern JSObject *
LM_ReflectLink(MWContext *context, LO_AnchorData *anchor_data, PA_Tag * tag,
int32 layer_id, uint index);
extern JSObject *
LM_ReflectNamedAnchor(MWContext *context, struct lo_NameList_struct *name_rec,
PA_Tag * tag, int32 layer_id, uint index);
extern JSObject *
LM_ReflectImage(MWContext *context, LO_ImageStruct *image_data,
PA_Tag * tag, int32 layer_id, uint index);
extern JSBool
LM_CanDoJS(MWContext *context);
extern JSBool
LM_IsActive(MWContext *context);
/*
* Security.
*/
extern JSPrincipals *
LM_NewJSPrincipals(URL_Struct *archive, char *name, const char *codebase);
extern char *
LM_ExtractFromPrincipalsArchive(JSPrincipals *principals, char *name,
uint *length);
extern JSBool
LM_SetUntransformedSource(JSPrincipals *principals, char *original,
char *transformed);
extern JSPrincipals * PR_CALLBACK
LM_GetJSPrincipalsFromJavaCaller(JSContext *cx, int callerDepth);
/*
* LM_RegisterPrincipals will verify and register a set of principals
* in the decoder, modifying decoder->principals in the process. It
* returns the modified decoder.
*
* The "name" parameter may be NULL if "principals" was created with a name.
*/
extern JSPrincipals *
LM_RegisterPrincipals(MochaDecoder *decoder, JSPrincipals *principals,
char *name, char *src);
/*
* JavaScript Debugger support
*/
#ifdef JSDEBUGGER
extern NET_StreamClass*
LM_StreamBuilder( int format_out,
void *data_obj,
URL_Struct *URL_s,
MWContext *mwcontext );
extern JSBool
LM_GetJSDebugActive(void);
extern void
LM_JamSourceIntoJSDebug( const char *filename,
const char *str,
int32 len,
MWContext *mwcontext );
#endif
NSPR_END_EXTERN_C
#endif /* libmocha_h___ */

3586
mozilla/lib/layout/layutil.c Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,95 @@
#!gmake
#
# The contents of this file are subject to the Netscape Public License
# Version 1.0 (the "NPL"); you may not use this file except in
# compliance with the NPL. You may obtain a copy of the NPL at
# http://www.mozilla.org/NPL/
#
# Software distributed under the NPL is distributed on an "AS IS" basis,
# WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
# for the specific language governing rights and limitations under the
# NPL.
#
# The Initial Developer of this code under the NPL is Netscape
# Communications Corporation. Portions created by Netscape are
# Copyright (C) 1998 Netscape Communications Corporation. All Rights
# Reserved.
DEPTH = ../..
MODULE = mocha
LIBRARY_NAME = mocha
REQUIRES = lay net parse img js style layer applet dbm nspr security \
htmldlgs util jtools pref java libreg softupdt jsdebug
CSRCS = et_mocha.c \
et_moz.c \
lm_applt.c \
lm_bars.c \
lm_cmpnt.c \
lm_doc.c \
lm_embed.c \
lm_event.c \
lm_form.c \
lm_hardw.c \
lm_hist.c \
lm_href.c \
lm_img.c \
lm_init.c \
lm_input.c \
lm_nav.c \
lm_plgin.c \
lm_screen.c \
lm_supdt.c \
lm_taint.c \
lm_trggr.c \
lm_url.c \
lm_win.c \
lm_layer.c \
lm_wngrp.c \
$(NULL)
ifdef MOZ_JAVA
CSRCS += \
lm_jsd.c \
$(NULL)
endif
ifndef NO_SECURITY
CSRCS += lm_crypt.c lm_pk11.c
endif
include $(DEPTH)/config/rules.mk
DEFINES += -DDLL_SUFFIX=\"$(DLL_SUFFIX)\"
ifdef JS_THREADSAFE
DEFINES += -DJS_THREADSAFE
endif
EMBED_CFLAGS = $(CFLAGS) -I$(DEPTH)/lib/plugin
TAINT_CFLAGS = $(CFLAGS) -I$(DEPTH)/lib/libjar -I$(DEPTH)/sun-java/netscape/security/_jri
ifneq ($(OS_ARCH),OS2)
$(OBJDIR)/lm_embed.o: lm_embed.c
@$(MAKE_OBJDIR)
$(CC) -o $@ -c $(EMBED_CFLAGS) $<
$(OBJDIR)/lm_taint.o: lm_taint.c
@$(MAKE_OBJDIR)
$(CC) -o $@ -c $(TAINT_CFLAGS) $<
else
$(OBJDIR)/lm_embed.o: lm_embed.c
@$(MAKE_OBJDIR)
$(CC) -Fo$@ -c $(EMBED_CFLAGS) $<
$(OBJDIR)/lm_taint.o: lm_taint.c
@$(MAKE_OBJDIR)
$(CC) -Fo$@ -c $(TAINT_CFLAGS) $<
endif

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

880
mozilla/lib/libmocha/lm.h Normal file
View File

@@ -0,0 +1,880 @@
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* The contents of this file are subject to the Netscape Public License
* Version 1.0 (the "NPL"); you may not use this file except in
* compliance with the NPL. You may obtain a copy of the NPL at
* http://www.mozilla.org/NPL/
*
* Software distributed under the NPL is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
* for the specific language governing rights and limitations under the
* NPL.
*
* The Initial Developer of this code under the NPL is Netscape
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
* Reserved.
*/
#ifndef lm_h___
#define lm_h___
/*
* JS in the Navigator library-private interface.
*/
#include "xp.h" /* for uint and PA_Block */
#include "prlong.h" /* for int64 time type used below */
#include "libevent.h" /* until its a stand-alone */
#include "libmocha.h"
/*
* Shared string constants for common property names.
*/
extern char lm_argc_err_str[]; /* "incorrect number of arguments" */
extern char lm_unknown_origin_str[]; /* "[unknown origin]" */
extern char lm_onLoad_str[]; /* "onLoad" */
extern char lm_onUnload_str[]; /* "onUnload" */
extern char lm_onAbort_str[]; /* "onAbort" */
extern char lm_onError_str[]; /* "onError" */
extern char lm_onScroll_str[]; /* "onScroll" */
extern char lm_onFocus_str[]; /* "onFocus" */
extern char lm_onBlur_str[]; /* "onBlur" */
extern char lm_onSelect_str[]; /* "onSelect" */
extern char lm_onChange_str[]; /* "onChange" */
extern char lm_onReset_str[]; /* "onReset" */
extern char lm_onSubmit_str[]; /* "onSubmit" */
extern char lm_onClick_str[]; /* "onClick" */
extern char lm_onMouseDown_str[]; /* "onMouseDown" */
extern char lm_onMouseOver_str[]; /* "onMouseOver" */
extern char lm_onMouseOut_str[]; /* "onMouseOut" */
extern char lm_onMouseUp_str[]; /* "onMouseUp" */
extern char lm_onLocate_str[]; /* "onLocate" */
extern char lm_onHelp_str[]; /* "onHelp" [EA] */
extern char lm_focus_str[]; /* "focus" */
extern char lm_blur_str[]; /* "blur" */
extern char lm_select_str[]; /* "select" */
extern char lm_click_str[]; /* "click" */
extern char lm_scroll_str[]; /* "scroll" */
extern char lm_enable_str[]; /* "enable" */
extern char lm_disable_str[]; /* "disable" */
extern char lm_toString_str[]; /* "toString" */
extern char lm_length_str[]; /* "length" */
extern char lm_document_str[]; /* "document" */
extern char lm_forms_str[]; /* "forms" */
extern char lm_links_str[]; /* "links" */
extern char lm_anchors_str[]; /* "anchors" */
extern char lm_applets_str[]; /* "applets" */
extern char lm_embeds_str[]; /* "embeds" */
extern char lm_plugins_str[]; /* "plugins" */
extern char lm_images_str[]; /* "images" */
extern char lm_layers_str[]; /* "layers" */
extern char lm_location_str[]; /* "location" */
extern char lm_navigator_str[]; /* "navigator" */
extern char lm_netcaster_str[]; /* "netcaster" */
extern char lm_components_str[]; /* "components" */
extern char lm_parentLayer_str[]; /* "parentLayer" */
extern char lm_opener_str[]; /* "opener" */
extern char lm_closed_str[]; /* "closed" */
extern char lm_assign_str[]; /* "assign" */
extern char lm_reload_str[]; /* "reload" */
extern char lm_replace_str[]; /* "replace" */
extern char lm_event_str[]; /* "event" */
extern char lm_methodPrefix_str[]; /* "#method" */
extern char lm_methodArgc_str[]; /* "#method" */
extern char lm_methodArgv_str[]; /* "#method" */
extern char lm_getPrefix_str[]; /* "#get_" */
extern char lm_setPrefix_str[]; /* "#set_" */
extern char lm_typePrefix_str[]; /* "#type_" */
extern const char *lm_event_argv[]; /* {lm_event_str} */
extern PRThread *lm_InterpretThread;
extern PRThread *mozilla_thread;
extern PRThread *lm_js_lock_previous_owner;
extern JSContext *lm_writing_context;
/*
* Timeout structure threaded on MochaDecoder.timeouts for cleanup.
*/
struct JSTimeout {
int32 ref_count; /* reference count to shared usage */
char *expr; /* the JS expression to evaluate */
JSObject *funobj; /* or function to call, if !expr */
jsval *argv; /* function actual arguments */
void *toid; /* Identifier, used internally only */
uint32 public_id; /* Returned as value of setTimeout() */
uint16 argc; /* and argument count */
uint16 spare; /* alignment padding */
int32 doc_id; /* document this is for */
int32 interval; /* Non-zero if repetitive timeout */
int64 when; /* nominal time to run this timeout */
JSVersion version; /* Version of JavaScript to execute */
JSPrincipals *principals; /* principals with which to execute */
char *filename; /* filename of setTimeout call */
uint32 lineno; /* line number of setTimeout call */
JSTimeout *next; /* next timeout in list */
};
extern void lm_ClearWindowTimeouts(MochaDecoder *decoder);
struct JSNestingUrl {
JSNestingUrl *next;
char *str;
};
/*
* Event queue stack madness to handle doc.write("<script>doc.write...").
*/
typedef struct QueueStackElement {
PREventQueue * queue;
MWContext * context;
int32 doc_id;
struct QueueStackElement * up;
struct QueueStackElement * down;
PRPackedBool done;
PRPackedBool discarding;
PRPackedBool inherit_parent;
void * retval;
} QueueStackElement;
extern void
et_SubEventLoop(QueueStackElement * qse);
/*
* Stack size per window context, plus one for the navigator.
*/
#define LM_STACK_SIZE 8192
extern JSRuntime *lm_runtime;
extern JSClass lm_window_class;
extern JSClass lm_layer_class;
extern JSClass lm_document_class;
extern JSClass lm_event_class;
extern JSBool lm_SaveParamString(JSContext *cx, PA_Block *bp,
const char *str);
extern MochaDecoder *lm_NewWindow(MWContext *context);
extern void lm_DestroyWindow(MochaDecoder *decoder);
/*
* Hold and drop the reference count for tree back-edges that go from object
* private data to the containing decoder. These refs do not keep the object
* tree under decoder alive from the GC, but they do keep decoder from being
* destroyed and some out of order finalizer tripping over its freed memory.
*/
#ifdef DEBUG
extern MochaDecoder *lm_HoldBackCount(MochaDecoder *decoder);
extern void lm_DropBackCount(MochaDecoder *decoder);
#define HOLD_BACK_COUNT(decoder) lm_HoldBackCount(decoder)
#define DROP_BACK_COUNT(decoder) lm_DropBackCount(decoder)
#else
#define HOLD_BACK_COUNT(decoder) \
(((decoder) ? (decoder)->back_count++ : 0), (decoder))
#define DROP_BACK_COUNT(decoder) \
(((decoder) && --(decoder)->back_count <= 0 && !(decoder)->forw_count) \
? lm_DestroyWindow(decoder) \
: (void)0)
#endif
extern JSBool lm_InitWindowContent(MochaDecoder *decoder);
extern JSBool lm_DefineWindowProps(JSContext *cx,
MochaDecoder *decoder);
extern JSBool lm_ResolveWindowProps(JSContext *cx,
MochaDecoder *decoder,
JSObject *obj,
jsval id);
extern void lm_FreeWindowContent(MochaDecoder *decoder,
JSBool fromDiscard);
extern JSBool lm_SetInputStream(JSContext *cx,
MochaDecoder *decoder,
NET_StreamClass *stream,
URL_Struct *url_struct,
JSBool free_stream_on_close);
extern JSObject *lm_DefineDocument(MochaDecoder *decoder,
int32 layer_id);
extern JSObject *lm_DefineHistory(MochaDecoder *decoder);
extern JSObject *lm_DefineLocation(MochaDecoder *decoder);
extern JSObject *lm_DefineNavigator(MochaDecoder *decoder);
extern JSObject *lm_DefineComponents(MochaDecoder *decoder);
extern JSObject *lm_DefineCrypto(MochaDecoder *decoder);
extern JSObject *lm_DefineScreen(MochaDecoder *decoder,
JSObject *parent);
extern JSObject *lm_DefineHardware(MochaDecoder *decoder,
JSObject *parent);
extern JSBool lm_DefinePluginClasses(MochaDecoder *decoder);
extern JSBool lm_DefineBarClasses(MochaDecoder *decoder);
extern JSBool lm_ResolveBar(JSContext *cx, MochaDecoder *decoder,
const char *name);
extern JSBool lm_DefineTriggers(void);
extern JSObject *lm_NewPluginList(JSContext *cx, JSObject *parent_obj);
extern JSObject *lm_NewMIMETypeList(JSContext *cx);
extern JSObject *lm_GetDocumentFromLayerId(MochaDecoder *decoder,
int32 layer_id);
extern JSObject *lm_DefinePkcs11(MochaDecoder *decoder);
/*
* Get (create if needed) document's form, link, and named anchor arrays.
*/
extern JSObject *lm_GetFormArray(MochaDecoder *decoder,
JSObject *document);
extern JSObject *lm_GetLinkArray(MochaDecoder *decoder,
JSObject *document);
extern JSObject *lm_GetNameArray(MochaDecoder *decoder,
JSObject *document);
extern JSObject *lm_GetAppletArray(MochaDecoder *decoder,
JSObject *document);
extern JSObject *lm_GetEmbedArray(MochaDecoder *decoder,
JSObject *document);
extern JSObject *lm_GetImageArray(MochaDecoder *decoder,
JSObject *document);
extern JSObject *lm_GetDocumentLayerArray(MochaDecoder *decoder,
JSObject *document);
/*
* dummy object for applets and embeds that can't be reflected
*/
extern JSObject *lm_DummyObject;
extern void lm_InitDummyObject(JSContext *cx);
/* bit vector for handlers */
typedef enum {
HANDLER_ONCLICK = 1 << 0,
HANDLER_ONFOCUS = 1 << 1,
HANDLER_ONBLUR = 1 << 2,
HANDLER_ONCHANGE = 1 << 3,
HANDLER_ONSELECT = 1 << 4,
HANDLER_ONSCROLL = 1 << 5,
HANDLER_ONMOUSEDOWN = 1 << 6,
HANDLER_ONMOUSEUP = 1 << 7,
HANDLER_ONKEYDOWN = 1 << 8,
HANDLER_ONKEYUP = 1 << 9,
HANDLER_ONKEYPRESS = 1 << 10,
HANDLER_ONDBLCLICK = 1 << 11
} JSHandlersBitVector;
/*
* Base class of all JS input private object data structures.
*/
typedef struct JSInputBase {
MochaDecoder *decoder; /* this window's JS decoder */
int32 type; /* layout form element type */
JSHandlersBitVector handlers; /* bit vector for handlers */
} JSInputBase;
/*
* Base class of event-handling elements like layers and documents.
*/
typedef struct JSInputHandler {
JSInputBase base; /* decoder and type */
JSObject *object; /* this input handler's JS object */
uint32 event_mask; /* mask of events in progress */
} JSInputHandler;
/*
* Base class of input event-capturing elements like layers and documents.
*/
typedef struct JSEventReceiver {
JSObject *object; /* this event receiver's JS object */
uint32 event_mask; /* mask of events in progress */
} JSEventReceiver;
/*
* Base class of input event-handling elements like anchors and form inputs.
*/
typedef struct JSEventCapturer {
JSEventReceiver base; /* this event capturer's receiver base */
uint32 event_bit; /* mask of events being captured */
} JSEventCapturer;
#define base_decoder base.decoder
#define base_type base.type
#define base_handlers base.handlers
/*
* JS URL object.
*
* Location is a special URL: when you set one of its properties, your client
* window goes to the newly formed address.
*/
typedef struct JSURL {
JSInputHandler handler;
int32 layer_id;
uint32 index;
JSString *href;
JSString *target;
JSString *text;
} JSURL;
/* JS Document Object
* Documents exist per-window and per-layer
*/
typedef struct JSDocument {
JSEventCapturer capturer;
MochaDecoder *decoder;
JSObject *object;
int32 layer_id; /* The containing layer's id */
JSObject *forms;
JSObject *links;
JSObject *anchors;
JSObject *applets;
JSObject *embeds;
JSObject *images;
JSObject *layers;
} JSDocument;
#define URL_NOT_INDEXED ((uint32)-1)
#define url_decoder handler.base_decoder
#define url_type handler.base_type
#define url_object handler.object
#define url_event_mask handler.event_mask
extern JSURL *
lm_NewURL(JSContext *cx, MochaDecoder *decoder,
LO_AnchorData *anchor_data, JSObject *document);
extern void
lm_ReplaceURL(MWContext *context, URL_Struct *url_struct);
extern JSBool
lm_GetURL(JSContext *cx, MochaDecoder *decoder, URL_Struct *url_struct);
extern const char *
lm_CheckURL(JSContext *cx, const char *url_string, JSBool checkFile);
extern JSBool
lm_CheckWindowName(JSContext *cx, const char *window_name);
extern PRHashTable *
lm_GetIdToObjectMap(MochaDecoder *decoder);
extern JSBool PR_CALLBACK
lm_BranchCallback(JSContext *cx, JSScript *script);
extern void PR_CALLBACK
lm_ErrorReporter(JSContext *cx, const char *message,
JSErrorReport *report);
extern JSObject *
lm_GetFormObjectByID(MWContext *context, int32 layer_id, uint form_id);
extern LO_FormElementStruct *
lm_GetFormElementByIndex(JSContext * cx, JSObject *form_obj, int32 index);
extern JSObject *
lm_GetFormElementFromMapping(JSContext *cx, JSObject *form_obj, uint32 index);
extern JSBool
lm_AddFormElement(JSContext *cx, JSObject *form, JSObject *obj,
char *name, uint index);
extern JSBool
lm_ReflectRadioButtonArray(MWContext *context, int32 layer_id, intn form_id,
const char *name, PA_Tag * tag);
extern JSBool
lm_SendEvent(MWContext *context, JSObject *obj, JSEvent *event,
jsval *result);
extern JSBool
lm_HandleEvent(JSContext *cx, JSObject *obj, JSObject *eventObj,
jsval funval, jsval *result);
extern JSBool
lm_FindEventHandler(MWContext *context, JSObject *obj, JSObject *eventObj,
jsval funval, jsval *result);
extern JSObject *
lm_NewEventObject(MochaDecoder * decoder, JSEvent * pEvent);
typedef struct JSEventNames {
const char *lowerName;
const char *mixedName;
} JSEventNames;
extern const char *
lm_EventName(uint32 event_bit);
extern JSEventNames *
lm_GetEventNames(uint32 event_bit);
/*
* Compile the given attribute and attach it to the JSObject
*/
extern JSBool
lm_CompileEventHandler(MochaDecoder * decoder, PA_Block id, PA_Block data,
int newline_(cx, sizeof *option);
if (!option)
goto bad;
option_obj =
JS_NewObject(cx, &lm_option_class,
input->input_decoder->option_prototype, obj);
if (!option_obj || !JS_SetPrivate(cx, option_obj, option)) {
JS_free(cx, option);
goto bad;
}
option->decoder = HOLD_BACK_COUNT(input->input_decoder);
option->object = option_obj;
option->index = (uint32)slot;
option->indexInForm = form_element->element_index;
option->data = NULL;
*vp = OBJECT_TO_JSVAL(option_obj);
goto good;
}
}
break;
case FORM_TYPE_RADIO:
case FORM_TYPE_CHECKBOX:
{
lo_FormElementToggleData *toggle;
toggle = &form_element->element_data->ele_toggle;
switch (input_slot) {
case INPUT_NAME:
str = lm_LocalEncodingToStr(context,
(char *)toggle->name);
break;
case INPUT_VALUE:
str = lm_LocalEncodingToStr(context,
(char *)toggle->value);
break;
case INPUT_STATUS:
*vp = BOOLEAN_TO_JSVAL(toggle->toggled);
goto good;
case INPUT_DEFAULT_STATUS:
*vp = BOOLEAN_TO_JSVAL(toggle->default_toggle);
goto good;
#if DISABLED_READONLY_SUPPORT
case INPUT_DISABLED:
*vp = BOOLEAN_TO_JSVAL(toggle->disabled);
goto good;
case INPUT_READONLY:
*vp = BOOLEAN_TO_JSVAL(FALSE);
goto good;
#endif
default:
/* Don't mess with a user-defined property. */
goto good;
}
}
break;
default:
{
lo_FormElementMinimalData *minimal;
minimal = &form_element->element_data->ele_minimal;
switch (input_slot) {
case INPUT_NAME:
str = lm_LocalEncodingToStr(context,
(char *)minimal->name);
break;
case INPUT_VALUE:
str = lm_LocalEncodingToStr(context,
(char *)minimal->value);
break;
#if DISABLED_READONLY_SUPPORT
case INPUT_DISABLED:
*vp = BOOLEAN_TO_JSVAL(minimal->disabled);
goto good;
case INPUT_READONLY:
*vp = BOOLEAN_TO_JSVAL(FALSE); /* minimal elements don't have the readonly attribute. */
goto good;
#endif
default:
/* Don't mess with a user-defined property. */
goto good;
}
}
break;
}
if (!str)
goto bad;
*vp = STRING_TO_JSVAL(str);
good:
LO_UnlockLayout();
return JS_TRUE;
bad:
LO_UnlockLayout();
return JS_FALSE;
}
char *
lm_FixNewlines(JSContext *cx, const char *value, JSBool formElement)
{
size_t size;
const char *cp;
char *tp, *new_value;
#if defined XP_PC
size = 1;
for (cp = value; *cp != '\0'; cp++) {
switch (*cp) {
case '\r':
if (cp[1] != '\n')
size++;
break;
case '\n':
if (cp > value && cp[-1] != '\r')
size++;
break;
}
}
size += cp - value;
#else
size = XP_STRLEN(value) + 1;
#endif
new_value = JS_malloc(cx, size);
if (!new_value)
return NULL;
for (cp = value, tp = new_value; *cp != '\0'; cp++) {
#if defined XP_MAC
if (*cp == '\n') {
if (cp > value && cp[-1] != '\r')
*tp++ = '\r';
} else {
*tp++ = *cp;
}
#elif defined XP_PC
switch (*cp) {
case '\r':
*tp++ = '\r';
if (cp[1] != '\n' && formElement)
*tp++ = '\n';
break;
case '\n':
if (cp > value && cp[-1] != '\r' && formElement)
*tp++ = '\r';
*tp++ = '\n';
break;
default:
*tp++ = *cp;
break;
}
#else /* XP_UNIX */
if (*cp == '\r') {
if (cp[1] != '\n')
*tp++ = '\n';
} else {
*tp++ = *cp;
}
#endif
}
*tp = '\0';
return new_value;
}
PR_STATIC_CALLBACK(JSBool)
input_setProperty(JSContext *cx, JSObject *obj, jsval id, jsval *vp)
{
JSInput *input;
enum input_slot input_slot;
const char *prop_name;
char *value = NULL;
LO_FormElementStruct *form_element;
MochaDecoder *decoder;
MWContext *context;
int32 intval;
jsint slot;
input = JS_GetInstancePrivate(cx, obj, &lm_input_class, NULL);
if (!input)
return JS_TRUE;
/* If the property is seting a key handler we find out now so
* that we can tell the front end to send the event. */
if (JSVAL_IS_STRING(id)) {
prop_name = JS_GetStringBytes(JSVAL_TO_STRING(id));
/* XXX use lm_onKeyDown_str etc. initialized by PARAM_ONKEYDOWN */
if (XP_STRCASECMP(prop_name, "onkeydown") == 0 ||
XP_STRCASECMP(prop_name, "onkeyup") == 0 ||
XP_STRCASECMP(prop_name, "onkeypress") == 0) {
form_element = lm_GetFormElementByIndex(cx, JS_GetParent(cx, obj),
input->index);
form_element->event_handler_present = TRUE;
}
return JS_TRUE;
}
XP_ASSERT(JSVAL_IS_INT(id));
slot = JSVAL_TO_INT(id);
decoder = input->input_decoder;
context = decoder->window_context;
input_slot = slot;
switch (input_slot) {
case INPUT_TYPE:
case INPUT_FORM:
case INPUT_OPTIONS:
/* These are immutable. */
break;
case INPUT_NAME:
case INPUT_VALUE:
case INPUT_DEFAULT_VALUE:
/* These are string-valued. */
if (!JSVAL_IS_STRING(*vp) &&
!JS_ConvertValue(cx, *vp, JSTYPE_STRING, vp)) {
return JS_FALSE;
}
value = lm_StrToLocalEncoding(context, JSVAL_TO_STRING(*vp));
break;
case INPUT_STATUS:
case INPUT_DEFAULT_STATUS:
#if DISABLED_READONLY_SUPPORT
case INPUT_READONLY:
case INPUT_DISABLED:
#endif
/* These must be Booleans. */
if (!JSVAL_IS_BOOLEAN(*vp) &&
!JS_ConvertValue(cx, *vp, JSTYPE_BOOLEAN, vp)) {
return JS_FALSE;
}
break;
case INPUT_LENGTH:
case INPUT_SELECTED_INDEX:
/* These should be integers. */
if (JSVAL_IS_INT(*vp))
intval = JSVAL_TO_INT(*vp);
else if (!JS_ValueToInt32(cx, *vp, &intval)) {
return JS_FALSE;
}
break;
}
LO_LockLayout();
form_element = lm_GetFormElementByIndex(cx, JS_GetParent(cx, obj),
input->index);
if (!form_element)
goto good;
switch (form_element->element_data->type) {
case FORM_TYPE_FILE:
/* if we try to set a file upload widget we better be a signed script */
if (!lm_CanAccessTarget(cx, JSTARGET_UNIVERSAL_FILE_READ))
break;
/* else fall through... */
case FORM_TYPE_TEXT:
case FORM_TYPE_TEXTAREA: /* XXX we ASSUME common struct prefixes */
case FORM_TYPE_PASSWORD:
{
lo_FormElementTextData *text;
JSBool ok;
char * fixed_string;
text = &form_element->element_data->ele_text;
switch (input_slot) {
case INPUT_NAME:
if (!lm_SaveParamString(cx, &text->name, value))
goto bad;
break;
case INPUT_VALUE:
case INPUT_DEFAULT_VALUE:
fixed_string = lm_FixNewlines(cx, value, JS_TRUE);
if (!fixed_string)
goto bad;
ok = (input_slot == INPUT_VALUE)
? lm_SaveParamString(cx, &text->current_text, fixed_string)
: lm_SaveParamString(cx, &text->default_text, fixed_string);
JS_free(cx, (char *)fixed_string);
if (!ok)
goto bad;
if (input_slot == INPUT_VALUE && context) {
ET_PostManipulateForm(context, (LO_Element *)form_element,
EVENT_CHANGE);
}
break;
#if DISABLED_READONLY_SUPPORT
case INPUT_DISABLED:
text->disabled = JSVAL_TO_BOOLEAN(*vp);
if (context) {
ET_PostManipulateForm(context, (LO_Element *)form_element,
EVENT_CHANGE);
}
break;
case INPUT_READONLY:
if (form_element->element_data->type == FORM_TYPE_FILE)
break;
text->readonly = JSVAL_TO_BOOLEAN(*vp);
if (context) {
ET_PostManipulateForm(context, (LO_Element *)form_element,
EVENT_CHANGE);
}
break;
#endif
default:
/* Don't mess with option or user-defined property. */
goto good;
}
}
break;
case FORM_TYPE_SELECT_ONE:
case FORM_TYPE_SELECT_MULT:
{
lo_FormElementSelectData *selectData;
lo_FormElementOptionData *optionData;
JSSelectOption *option;
int32 i, new_option_cnt, old_option_cnt;
selectData = &form_element->element_data->ele_select;
switch (slot) {
case INPUT_NAME:
if (!lm_SaveParamString(cx, &selectData->name, value))
goto bad;
break;
case INPUT_LENGTH:
new_option_cnt = intval;
old_option_cnt = selectData->option_cnt;
optionData = (lo_FormElementOptionData *) selectData->options;
/* Remove truncated slots, or clear extended element data. */
if (new_ayer(MWContext *context, int32 wrap_width, int32 parent_layer_id);
extern void
lm_RestoreLayerState(MWContext *context, int32 layer_id,
LO_BlockInitializeStruct *param);
extern PRHashNumber
lm_KeyHash(const void *key);
extern JSBool
lm_jsval_to_rgb(JSContext *cx, jsval *vp, LO_Color **rgbp);
extern JSBool
layer_setBgColorProperty(JSContext *cx, JSObject *obj, jsval *vp);
extern JSObject *
lm_GetActiveContainer(MochaDecoder *decoder);
extern JSBool
lm_GetPrincipalsCompromise(JSContext *cx, JSObject *obj);
extern char *
lm_FixNewlines(JSContext *cx, const char *value, JSBool formElement);
extern JSBool PR_CALLBACK
win_open(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval);
/* defined in libmocha.h */
#ifdef JSDEBUGGER
extern void
lm_InitJSDebug(JSRuntime *jsruntime);
extern void
lm_ExitJSDebug(JSRuntime *jsruntime);
#endif
#define IS_MESSAGE_WINDOW(context) \
(((context)->type == MWContextMail) || \
((context)->type == MWContextNews) || \
((context)->type == MWContextMailMsg) || \
((context)->type == MWContextNewsMsg))
/* INTL support */
extern char *
lm_StrToLocalEncoding(MWContext * context, JSString * str);
extern JSString *
lm_LocalEncodingToStr(MWContext * context, char * bytes);
/* end INTL support */
/* MLM */
typedef struct lm_lock_waiter {
JSLockReleaseFunc fn;
void * data;
struct lm_lock_waiter * next;
} lm_lock_waiter;
typedef struct ContextListStr ContextList;
typedef struct WindowGroup LMWindowGroup;
struct WindowGroup {
LMWindowGroup *next;
LMWindowGroup *prev;
/* XXXMLM - this entry is currently unused; it should eventually hold
* a shared JSContext for the thread group.
*/
JSContext *js_context;
PRBool interruptCurrentOp;
PRMonitor *owner_monitor;
PRThread *thread;
PRThread *owner;
lm_lock_waiter *waiting_list;
int32 current_count;
PRBool mozWantsLock;
PRBool mozGotLock;
PRBool hasLock;
JSContext *lock_context;
JSTimeout **js_timeout_insertion_point;
JSTimeout *js_timeout_running;
uint inputRecurring;
PREventQueue *interpret_queue;
QueueStackElement *queue_stack;
uint queue_depth;
uint queue_count;
PRMonitor *queue_monitor;
ContextList *mw_contexts;
MWContext *current_context;
PRBool done;
};
extern void lm_InitWindowGroups(void);
extern LMWindowGroup *lm_NewWindowGroup(void);
extern void lm_StartWindowGroup(LMWindowGroup *grp);
extern void lm_DestroyWindowGroup(LMWindowGroup *grp);
extern LMWindowGroup *LM_GetDefaultWindowGroup(MWContext *mwc);
extern LMWindowGroup *lm_MWContextToGroup(MWContext *mwc);
extern LMWindowGroup *lm_QueueStackToGroup(QueueStackElement *qse);
extern PREventQueue *LM_MWContextToQueue(MWContext *mwc);
extern PREventQueue *LM_WindowGroupToQueue(LMWindowGroup *lmg);
extern ContextList *lm_GetEntryForContext(LMWindowGroup *grp, MWContext *cx);
extern void LM_AddContextToGroup(LMWindowGroup *grp, MWContext *cx);
extern void LM_RemoveContextFromGroup(MWContext *cx);
extern PRBool LM_IsLocked(LMWindowGroup *grp);
extern void LM_BeginRequest(LMWindowGroup *grp, JSContext *jsc);
extern void LM_EndRequest(LMWindowGroup *grp, JSContext *jsc);
extern void LM_LockJSByGroup(LMWindowGroup *grp);
extern void LM_UnlockJSByGroup(LMWindowGroup *grp);
extern JSBool lm_inited(void);
extern JSContext *LM_GetCrippledContext(void);
extern MochaDecoder *LM_GetCrippledDecoder(void);
extern void LM_SetCrippledDecoder(MochaDecoder *md);
extern JSBool LM_ShouldRunGC(JSContext *cx, JSGCStatus status);
/* MLM */
#endif /* lm_h___ */

View File

@@ -0,0 +1,675 @@
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* The contents of this file are subject to the Netscape Public License
* Version 1.0 (the "NPL"); you may not use this file except in
* compliance with the NPL. You may obtain a copy of the NPL at
* http://www.mozilla.org/NPL/
*
* Software distributed under the NPL is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
* for the specific language governing rights and limitations under the
* NPL.
*
* The Initial Developer of this code under the NPL is Netscape
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
* Reserved.
*/
/*
* JS reflection of Navigator Components.
*
* Created: Tom Pixley, 4/22/97
*
*/
#include "lm.h"
#include "prmem.h"
#include "np.h"
#include "net.h"
#include "fe_proto.h"
/*
* -----------------------------------------------------------------------
*
* Data types
*
* -----------------------------------------------------------------------
*/
typedef struct JSComponent
{
MochaDecoder *decoder;
JSObject *obj;
JSString *name;
ETBoolPtrFunc active_callback;
ETVoidPtrFunc startup_callback;
} JSComponent;
typedef struct JSComponentArray
{
MochaDecoder *decoder;
JSObject *obj;
jsint length;
} JSComponentArray;
typedef struct JSPreDefComponent
{
const char *name;
ETVerifyComponentFunc func;
} JSPreDefComponent;
static JSPreDefComponent predef_components[] =
{
{0}
};
/*
* -----------------------------------------------------------------------
*
* Reflection of an installed component.
*
* -----------------------------------------------------------------------
*/
enum component_slot
{
COMPONENT_NAME = -1,
COMPONENT_ACTIVE = -2
};
static JSPropertySpec component_props[] =
{
{"name", COMPONENT_NAME, JSPROP_ENUMERATE | JSPROP_READONLY},
{"active", COMPONENT_ACTIVE, JSPROP_ENUMERATE | JSPROP_READONLY},
{0}
};
extern JSClass lm_component_class;
PR_STATIC_CALLBACK(JSBool)
component_getProperty(JSContext *cx, JSObject *obj, jsval id, jsval *vp)
{
JSComponent *component;
JSString *str;
jsint slot;
if (!JSVAL_IS_INT(id))
return JS_TRUE;
slot = JSVAL_TO_INT(id);
component = JS_GetInstancePrivate(cx, obj, &lm_component_class, NULL);
if (!component)
return JS_TRUE;
switch (slot) {
case COMPONENT_NAME:
str = component->name;
if (str)
*vp = STRING_TO_JSVAL(str);
else
*vp = JS_GetEmptyStringValue(cx);
break;
case COMPONENT_ACTIVE:
*vp = JSVAL_FALSE;
if (ET_moz_CallFunctionBool((ETBoolPtrFunc)component->active_callback, NULL))
*vp = JSVAL_TRUE;
break;
default:
break;
}
return JS_TRUE;
}
PR_STATIC_CALLBACK(JSBool)
component_mozilla_getProperty(JSContext *cx, JSObject *obj, jsval id, jsval *vp)
{
char *name, *type_str, *get_str;
jsval type, func;
if (!JSVAL_IS_STRING(id))
return JS_TRUE;
name = JS_GetStringBytes(JSVAL_TO_STRING(id));
type_str = JS_malloc(cx, XP_STRLEN(lm_typePrefix_str) + XP_STRLEN(name) + 1);
get_str = JS_malloc(cx, XP_STRLEN(lm_getPrefix_str) + XP_STRLEN(name) + 1);
if (!type_str || !get_str)
return JS_TRUE;
XP_STRCPY(type_str, lm_typePrefix_str);
XP_STRCAT(type_str, name);
XP_STRCPY(get_str, lm_getPrefix_str);
XP_STRCAT(get_str, name);
if (!JS_GetProperty(cx, obj, type_str, &type) ||
!JSVAL_IS_INT(type) ||
!JS_GetProperty(cx, obj, get_str, &func))
return JS_TRUE;
JS_free(cx, type_str);
JS_free(cx, get_str);
switch(JSVAL_TO_INT(type)) {
case ARGTYPE_INT32:
*vp = INT_TO_JSVAL((int32)ET_moz_CompGetterFunction((ETCompPropGetterFunc)JSVAL_TO_INT(func), name));
break;
case ARGTYPE_BOOL:
*vp = BOOLEAN_TO_JSVAL((JSBool)ET_moz_CompGetterFunction((ETCompPropGetterFunc)JSVAL_TO_INT(func), name));
break;
case ARGTYPE_STRING:
*vp = STRING_TO_JSVAL(JS_NewStringCopyZ(cx,
(char*)ET_moz_CompGetterFunction((ETCompPropGetterFunc)JSVAL_TO_INT(func), name)));
break;
}
return JS_TRUE;
}
PR_STATIC_CALLBACK(JSBool)
component_mozilla_setProperty(JSContext *cx, JSObject *obj, jsval id, jsval *vp)
{
char *name, *type_str, *set_str, *prop_val;
jsval type, func;
if (!JSVAL_IS_STRING(id))
return JS_TRUE;
name = JS_GetStringBytes(JSVAL_TO_STRING(id));
type_str = JS_malloc(cx, XP_STRLEN(lm_typePrefix_str) + XP_STRLEN(name) + 1);
set_str = JS_malloc(cx, XP_STRLEN(lm_setPrefix_str) + XP_STRLEN(name) + 1);
if (!type_str || !set_str)
return JS_TRUE;
XP_STRCPY(type_str, lm_typePrefix_str);
XP_STRCAT(type_str, name);
XP_STRCPY(set_str, lm_setPrefix_str);
XP_STRCAT(set_str, name);
if (!JS_GetProperty(cx, obj, type_str, &type) ||
!JSVAL_IS_INT(type) ||
!JS_GetProperty(cx, obj, set_str, &func))
return JS_TRUE;
JS_free(cx, type_str);
JS_free(cx, set_str);
switch(JSVAL_TO_INT(type)) {
case ARGTYPE_INT32:
if (JSVAL_IS_INT(*vp))
ET_moz_CompSetterFunction((ETCompPropSetterFunc)JSVAL_TO_INT(func), name, (void*)JSVAL_TO_INT(*vp));
break;
case ARGTYPE_BOOL:
if (JSVAL_IS_BOOLEAN(*vp))
ET_moz_CompSetterFunction((ETCompPropSetterFunc)JSVAL_TO_INT(func), name, (void*)JSVAL_TO_BOOLEAN(*vp));
break;
case ARGTYPE_STRING:
if (JSVAL_IS_STRING(*vp)) {
prop_val = JS_GetStringBytes(JSVAL_TO_STRING(*vp));
ET_moz_CompSetterFunction((ETCompPropSetterFunc)JSVAL_TO_INT(func), name, (void*)prop_val);
}
break;
}
return JS_TRUE;
}
void
lm_RegisterComponentProp(const char *comp, const char *targetName,
uint8 retType, ETCompPropSetterFunc setter,
ETCompPropGetterFunc getter)
{
JSContext *cx;
JSObject *arrayObj, *obj;
jsval val;
char *type, *set, *get;
MochaDecoder *cd = LM_GetCrippledDecoder();
if (!comp || !targetName || !(cx = cd->js_context))
return;
arrayObj = lm_DefineComponents(cd);
if (!arrayObj)
return;
if (!JS_GetProperty(cx, arrayObj, comp, &val) ||
!JSVAL_IS_OBJECT(val))
return;
obj = JSVAL_TO_OBJECT(val);
if (!JS_DefineProperty(cx, obj, targetName, JSVAL_VOID, component_mozilla_getProperty,
component_mozilla_setProperty, 0)) {
}
type = JS_malloc(cx, XP_STRLEN(lm_typePrefix_str) + XP_STRLEN(targetName) + 1);
if (type) {
XP_STRCPY(type, lm_typePrefix_str);
XP_STRCAT(type, targetName);
if (!JS_DefineProperty(cx, obj, type,
INT_TO_JSVAL((int32)retType), 0, 0, JSPROP_READONLY)) {
}
JS_free(cx, type);
}
get = JS_malloc(cx, XP_STRLEN(lm_getPrefix_str) + XP_STRLEN(targetName) + 1);
if (get) {
XP_STRCPY(get, lm_getPrefix_str);
XP_STRCAT(get, targetName);
if (!JS_DefineProperty(cx, obj, get,
INT_TO_JSVAL(getter), 0, 0, JSPROP_READONLY)) {
}
JS_free(cx, get);
}
set = JS_malloc(cx, XP_STRLEN(lm_setPrefix_str) + XP_STRLEN(targetName) + 1);
if (set) {
XP_STRCPY(set, lm_setPrefix_str);
XP_STRCAT(set, targetName);
if (!JS_DefineProperty(cx, obj, set,
INT_TO_JSVAL(setter), 0, 0, JSPROP_READONLY)) {
}
JS_free(cx, set);
}
}
PR_STATIC_CALLBACK(JSBool)
component_resolve_name(JSContext *cx, JSObject *obj, jsval id)
{
return JS_TRUE;
}
PR_STATIC_CALLBACK(void)
component_finalize(JSContext *cx, JSObject *obj)
{
JSComponent* component;
component = JS_GetPrivate(cx, obj);
if (!component)
return;
JS_UnlockGCThing(cx, component->name);
DROP_BACK_COUNT(component->decoder);
JS_free(cx, component);
}
JSClass lm_component_class =
{
"Component", JSCLASS_HAS_PRIVATE,
JS_PropertyStub, JS_PropertyStub,
component_getProperty, component_getProperty, JS_EnumerateStub,
component_resolve_name, JS_ConvertStub, component_finalize
};
PR_STATIC_CALLBACK(JSBool)
component_activate(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval)
{
JSComponent *component;
component = JS_GetInstancePrivate(cx, obj, &lm_component_class, argv);
if (!component)
return JS_FALSE;
ET_moz_CallFunctionAsync((ETVoidPtrFunc)component->startup_callback, NULL);
return JS_TRUE;
}
static JSFunctionSpec component_methods[] =
{
{"activate", component_activate, 0},
{0}
};
PR_STATIC_CALLBACK(JSBool)
component_mozilla_method_stub(JSContext *cx, JSObject *obj, uint argc,
jsval *argv, jsval *rval)
{
JSFunction *func;
JSObject *func_obj;
jsval type, native;
uint i;
JSCompArg *comp_argv;
func = JS_ValueToFunction(cx, argv[-2]);
func_obj = JS_GetFunctionObject(func);
if (!JS_GetProperty(cx, func_obj, lm_typePrefix_str, &type) ||
!JSVAL_IS_INT(type) ||
!JS_GetProperty(cx, func_obj, lm_methodPrefix_str, &native) ||
!(comp_argv = JS_malloc(cx, argc * sizeof(JSCompArg))))
return JS_TRUE;
for (i=0; i<argc; i++) {
if (JSVAL_IS_INT(argv[i])) {
comp_argv[i].type = ARGTYPE_INT32;
comp_argv[i].value.intArg = JSVAL_TO_INT(argv[i]);
}
else if (JSVAL_IS_BOOLEAN(argv[i])) {
comp_argv[i].type = ARGTYPE_BOOL;
comp_argv[i].value.boolArg = JSVAL_TO_BOOLEAN(argv[i]);
}
else if (JSVAL_IS_STRING(argv[i])) {
comp_argv[i].type = ARGTYPE_STRING;
comp_argv[i].value.stringArg = JS_GetStringBytes(JSVAL_TO_STRING(argv[i]));
}
else {
comp_argv[i].type = ARGTYPE_NULL;
comp_argv[i].value.intArg = 0;
}
}
switch(JSVAL_TO_INT(type)) {
case ARGTYPE_NULL:
ET_moz_CompMethodFunction((ETCompMethodFunc)JSVAL_TO_INT(native), argc, NULL);
*rval = 0;
break;
case ARGTYPE_INT32:
*rval = INT_TO_JSVAL((int32)ET_moz_CompMethodFunction((ETCompMethodFunc)JSVAL_TO_INT(native), argc, comp_argv));
break;
case ARGTYPE_BOOL:
*rval = BOOLEAN_TO_JSVAL((JSBool)ET_moz_CompMethodFunction((ETCompMethodFunc)JSVAL_TO_INT(native), argc, comp_argv));
break;
case ARGTYPE_STRING:
*rval = STRING_TO_JSVAL(JS_NewStringCopyZ(cx,
(char*)ET_moz_CompMethodFunction((ETCompMethodFunc)JSVAL_TO_INT(native), argc, comp_argv)));
break;
}
return JS_TRUE;
}
void
lm_RegisterComponentMethod(const char *comp, const char *targetName,
uint8 retType, ETCompMethodFunc method, int32 argc)
{
JSContext *cx;
JSObject *arrayObj, *obj, *func_obj;
JSFunction *func;
jsval val;
MochaDecoder *cd = LM_GetCrippledDecoder();
if (!comp || !targetName || !(cx = cd->js_context))
return;
arrayObj = lm_DefineComponents(cd);
if (!arrayObj)
return;
if (!JS_GetProperty(cx, arrayObj, comp, &val) ||
!JSVAL_IS_OBJECT(val))
return;
obj = JSVAL_TO_OBJECT(val);
if (!(func = JS_DefineFunction(cx, obj, targetName, component_mozilla_method_stub, argc, 0))){
}
func_obj = JS_GetFunctionObject(func);
if (!JS_DefineProperty(cx, func_obj, lm_typePrefix_str,
INT_TO_JSVAL((int32)retType), 0, 0, JSPROP_READONLY))
return;
if (!JS_DefineProperty(cx, func_obj, lm_methodPrefix_str,
INT_TO_JSVAL(method), 0, 0, JSPROP_READONLY))
return;
if (!JS_DefineProperty(cx, func_obj, lm_methodArgc_str,
INT_TO_JSVAL(argc), 0, 0, JSPROP_READONLY))
return;
}
/* Constructor method for a JSComponent object */
static JSComponent*
component_create_self(JSContext *cx, MochaDecoder* decoder, JSComponent *component, const char *name)
{
JSObject *obj;
/* JSComponent may be malloc'd previous to this to make it easier
* to fill in the struct with data from the Mozilla thread
*/
if (!component) {
component = JS_malloc(cx, sizeof(JSComponent));
if (!component)
return NULL;
}
obj = JS_NewObject(cx, &lm_component_class, NULL, NULL);
if (!obj || !JS_SetPrivate(cx, obj, component)) {
JS_free(cx, component);
return NULL;
}
if (!JS_DefineProperties(cx, obj, component_props))
return NULL;
if (!JS_DefineFunctions(cx, obj, component_methods))
return NULL;
/* Fill out static property fields */
component->decoder = HOLD_BACK_COUNT(decoder);
component->obj = obj;
component->name = JS_NewStringCopyZ(cx, name);
if (!component->name || !JS_LockGCThing(cx, component->name))
return NULL;
return component;
}
/*
* -----------------------------------------------------------------------
*
* Reflection of the list of installed components.
* The only static property is the array length;
* the array elements (JSComponents) are added
* lazily when referenced.
*
* -----------------------------------------------------------------------
*/
enum componentarray_slot
{
COMPONENTLIST_ARRAY_LENGTH = -1
};
static JSPropertySpec componentarray_props[] =
{
{"length", COMPONENTLIST_ARRAY_LENGTH, JSPROP_READONLY},
{0}
};
/* Look up the component for the specified slot of the plug-in list */
static JSComponent*
componentarray_create_component(JSContext *cx, JSComponentArray *array,
JSComponent *component, const char *targetName, jsint targetSlot)
{
component = component_create_self(cx, array->decoder, component, targetName);
if (component) {
char *name;
jsval val;
name = JS_GetStringBytes(component->name);
val = OBJECT_TO_JSVAL(component->obj);
JS_DefineProperty(cx, array->obj, name, val, NULL, NULL,
JSPROP_ENUMERATE);
JS_AliasElement(cx, array->obj, name, targetSlot);
array->length++;
return component;
}
return NULL;
}
extern JSClass lm_component_array_class;
void
lm_RegisterComponent(const char *targetName, ETBoolPtrFunc active_callback,
ETVoidPtrFunc startup_callback)
{
JSContext *cx;
JSObject *arrayObj;
JSComponentArray *array;
JSComponent *component;
jsval val;
MochaDecoder *cd = LM_GetCrippledDecoder();
if (!(cx = cd->js_context) || !targetName)
return;
arrayObj = lm_DefineComponents(cd);
if (!arrayObj)
return;
array = JS_GetInstancePrivate(cx, arrayObj, &lm_component_array_class, NULL);
if (!array)
return;
if (JS_GetProperty(cx, arrayObj, targetName, &val) && JSVAL_IS_OBJECT(val)) {
/* We already have a component by this name. Update the active and
* startup callback funcs in case ours are out of date
*/
component = JS_GetPrivate(cx, JSVAL_TO_OBJECT(val));
if (!component)
return;
component->active_callback = active_callback;
component->startup_callback = startup_callback;
return;
}
component = JS_malloc(cx, sizeof(JSComponent));
if (!component)
return;
component->active_callback = active_callback;
component->startup_callback = startup_callback;
componentarray_create_component(cx, array, component, targetName, array->length);
}
PR_STATIC_CALLBACK(JSBool)
componentarray_getProperty(JSContext *cx, JSObject *obj, jsval id, jsval *vp)
{
JSComponentArray *array;
jsint slot;
if (!JSVAL_IS_INT(id))
return JS_TRUE;
slot = JSVAL_TO_INT(id);
array = JS_GetInstancePrivate(cx, obj, &lm_component_array_class, NULL);
if (!array)
return JS_TRUE;
switch (slot) {
case COMPONENTLIST_ARRAY_LENGTH:
*vp = INT_TO_JSVAL(array->length);
break;
default:
/* Don't mess with a user-defined property. */
if (slot >= 0 && slot < (jsint) array->length) {
/* Search for an existing JSComponent for this slot */
JSObject* componentObj = NULL;
jsval val = *vp;
if (JSVAL_IS_OBJECT(val)) {
componentObj = JSVAL_TO_OBJECT(val);
}
else {
JSComponent* component;
component = componentarray_create_component(cx, array, NULL,
NULL, slot);
if (component)
componentObj = component->obj;
}
*vp = OBJECT_TO_JSVAL(componentObj);
break;
}
}
return JS_TRUE;
}
PR_STATIC_CALLBACK(void)
componentarray_finalize(JSContext *cx, JSObject *obj)
{
JSComponentArray* array;
array = JS_GetPrivate(cx, obj);
if (!array)
return;
DROP_BACK_COUNT(array->decoder);
JS_free(cx, array);
}
JSClass lm_component_array_class =
{
"ComponentArray", JSCLASS_HAS_PRIVATE,
JS_PropertyStub, JS_PropertyStub,
componentarray_getProperty, componentarray_getProperty, JS_EnumerateStub,
JS_ResolveStub, JS_ConvertStub, componentarray_finalize
};
JSObject*
lm_DefineComponents(MochaDecoder *decoder)
{
JSObject *obj;
JSComponentArray *array;
JSContext *cx = decoder->js_context;
JSPreDefComponent def_comps;
JSComponent *component;
jsint slot;
obj = decoder->components;
if (obj)
return obj;
array = JS_malloc(cx, sizeof(JSComponentArray));
if (!array)
return NULL;
XP_BZERO(array, sizeof *array);
obj = JS_NewObject(cx, &lm_component_array_class, NULL,
decoder->window_object);
if (!obj || !JS_SetPrivate(cx, obj, array)) {
JS_free(cx, array);
return NULL;
}
if (!JS_DefineProperties(cx, obj, componentarray_props))
return NULL;
array->decoder = HOLD_BACK_COUNT(decoder);
array->obj = obj;
/* Components can be added dynamically but some are predefined */
slot = 0;
array->length = 0;
def_comps = predef_components[slot];
while (def_comps.name) {
component = JS_malloc(cx, sizeof(JSComponent));
if (!component)
return NULL;
if (ET_moz_VerifyComponentFunction(def_comps.func, &(component->active_callback),
&(component->startup_callback))) {
componentarray_create_component(cx, array, component, def_comps.name, array->length);
}
else {
/*Component call failed somewhere.*/
JS_free(cx, component);
}
def_comps = predef_components[++slot];
}
return obj;
}

View File

@@ -0,0 +1,854 @@
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* The contents of this file are subject to the Netscape Public License
* Version 1.0 (the "NPL"); you may not use this file except in
* compliance with the NPL. You may obtain a copy of the NPL at
* http://www.mozilla.org/NPL/
*
* Software distributed under the NPL is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
* for the specific language governing rights and limitations under the
* NPL.
*
* The Initial Developer of this code under the NPL is Netscape
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
* Reserved.
*/
/*
* Image reflection and event notification
*
* Scott Furman, 3/30/96
*/
#include "lm.h"
#include "lo_ele.h"
#include "prtypes.h"
#include "pa_tags.h"
#include "layout.h"
#define IL_CLIENT
#include "libimg.h" /* Image Library public API. */
enum image_array_slot {
IMAGE_ARRAY_LENGTH = -1
};
static JSPropertySpec image_array_props[] = {
{lm_length_str, IMAGE_ARRAY_LENGTH,
JSPROP_ENUMERATE | JSPROP_READONLY | JSPROP_PERMANENT},
{0}
};
extern JSClass lm_image_array_class;
PR_STATIC_CALLBACK(JSBool)
image_array_getProperty(JSContext *cx, JSObject *obj, jsval id, jsval *vp)
{
JSObjectArray *array;
MochaDecoder *decoder;
MWContext *context;
jsint count, slot;
LO_ImageStruct *image;
int32 active_layer_id;
if (!JSVAL_IS_INT(id))
return JS_TRUE;
slot = JSVAL_TO_INT(id);
array = JS_GetInstancePrivate(cx, obj, &lm_image_array_class, NULL);
if (!array)
return JS_TRUE;
decoder = array->decoder;
context = decoder->window_context;
if (!context)
return JS_TRUE;
LO_LockLayout();
switch (slot) {
case IMAGE_ARRAY_LENGTH:
active_layer_id = LM_GetActiveLayer(context);
LM_SetActiveLayer(context, array->layer_id);
count = LO_EnumerateImages(context, array->layer_id);
LM_SetActiveLayer(context, active_layer_id);
if (count > array->length)
array->length = count;
*vp = INT_TO_JSVAL(count);
break;
default:
if (slot < 0) {
/* Don't mess with user-defined or method properties. */
LO_UnlockLayout();
return JS_TRUE;
}
if (slot >= array->length)
array->length = slot + 1;
image = LO_GetImageByIndex(context, array->layer_id, (uint)slot);
if (image) {
*vp = OBJECT_TO_JSVAL(LM_ReflectImage(context, image, NULL,
array->layer_id,
(uint)slot));
}
break;
}
LO_UnlockLayout();
return JS_TRUE;
}
PR_STATIC_CALLBACK(void)
image_array_finalize(JSContext *cx, JSObject *obj)
{
JSObjectArray *array;
array = JS_GetPrivate(cx, obj);
if (!array)
return;
DROP_BACK_COUNT(array->decoder);
JS_free(cx, array);
}
JSClass lm_image_array_class = {
"ImageArray", JSCLASS_HAS_PRIVATE,
JS_PropertyStub, JS_PropertyStub,
image_array_getProperty, image_array_getProperty, JS_EnumerateStub,
JS_ResolveStub, JS_ConvertStub, image_array_finalize
};
enum image_slot {
IMAGE_NAME = -2,
IMAGE_SRC = -3,
IMAGE_LOWSRC = -4,
IMAGE_X = -5,
IMAGE_Y = -6,
IMAGE_HEIGHT = -7,
IMAGE_WIDTH = -8,
IMAGE_BORDER = -9,
IMAGE_VSPACE = -10,
IMAGE_HSPACE = -11,
IMAGE_COMPLETE = -12
};
static JSPropertySpec image_props[] = {
{"name", IMAGE_NAME, JSPROP_ENUMERATE | JSPROP_READONLY},
{"src", IMAGE_SRC, JSPROP_ENUMERATE},
{"lowsrc", IMAGE_LOWSRC, JSPROP_ENUMERATE},
{"x", IMAGE_X, JSPROP_ENUMERATE | JSPROP_READONLY},
{"y", IMAGE_Y, JSPROP_ENUMERATE | JSPROP_READONLY},
{"height", IMAGE_HEIGHT, JSPROP_ENUMERATE | JSPROP_READONLY},
{"width", IMAGE_WIDTH, JSPROP_ENUMERATE | JSPROP_READONLY},
{"border", IMAGE_BORDER, JSPROP_ENUMERATE | JSPROP_READONLY},
{"vspace", IMAGE_VSPACE, JSPROP_ENUMERATE | JSPROP_READONLY},
{"hspace", IMAGE_HSPACE, JSPROP_ENUMERATE | JSPROP_READONLY},
{"complete", IMAGE_COMPLETE, JSPROP_ENUMERATE | JSPROP_READONLY},
{0}
};
/*
* Base image element type.
*/
typedef struct JSImage {
JSEventReceiver receiver;
MochaDecoder *decoder;
LO_ImageStruct *image_data; /* 0 unless made by new Image() */
uint8 pending_events;
int32 layer_id;
uint index;
JSBool complete; /* Finished loading or aborted */
JSString *name;
} JSImage;
#define GET_IMAGE_DATA(context, image) \
((image)->image_data ? (image)->image_data \
: LO_GetImageByIndex((context), (image)->layer_id, (image)->index))
extern JSClass lm_image_class;
/*
* Force the mozilla event queue to flush to make sure any image-set-src
* events have been processed
*/
PR_STATIC_CALLBACK(void)
lm_img_src_sync(void * data)
{
}
PR_STATIC_CALLBACK(JSBool)
image_getProperty(JSContext *cx, JSObject *obj, jsval id, jsval *vp)
{
JSImage *image;
LO_ImageStruct *image_data;
enum image_slot image_slot;
JSString *str;
jsint slot;
if (!JSVAL_IS_INT(id))
return JS_TRUE;
slot = JSVAL_TO_INT(id);
image = JS_GetInstancePrivate(cx, obj, &lm_image_class, NULL);
if (!image)
return JS_TRUE;
image_data = GET_IMAGE_DATA(image->decoder->window_context, image);
if (!image_data)
return JS_TRUE; /* Try to handle this case gracefully. */
image_slot = slot;
if (image_slot == IMAGE_SRC || image_slot == IMAGE_LOWSRC) {
if (!lm_CheckPermissions(cx, obj, JSTARGET_UNIVERSAL_BROWSER_READ))
return JS_FALSE;
}
switch (image_slot) {
case IMAGE_NAME:
if (image->name)
*vp = STRING_TO_JSVAL(image->name);
else
*vp = JSVAL_NULL;
break;
case IMAGE_SRC:
if (image_data->pending_mocha_event) {
ET_moz_CallFunction(lm_img_src_sync, NULL);
image_data->pending_mocha_event = PR_FALSE;
}
str = JS_NewStringCopyZ(cx, (char*)image_data->image_url);
if (!str)
return JS_FALSE;
*vp = STRING_TO_JSVAL(str);
break;
case IMAGE_LOWSRC:
if (image_data->pending_mocha_event) {
ET_moz_CallFunction(lm_img_src_sync, NULL);
image_data->pending_mocha_event = PR_FALSE;
}
str = JS_NewStringCopyZ(cx, (char*)image_data->lowres_image_url);
if (!str)
return JS_FALSE;
*vp = STRING_TO_JSVAL(str);
break;
case IMAGE_X:
*vp = INT_TO_JSVAL(image_data->x + image_data->x_offset);
break;
case IMAGE_Y:
*vp = INT_TO_JSVAL(image_data->y + image_data->y_offset);
break;
case IMAGE_HEIGHT:
*vp = INT_TO_JSVAL(image_data->height);
break;
case IMAGE_WIDTH:
*vp = INT_TO_JSVAL(image_data->width);
break;
case IMAGE_BORDER:
*vp = INT_TO_JSVAL(image_data->border_width);
break;
case IMAGE_HSPACE:
*vp = INT_TO_JSVAL(image_data->border_horiz_space);
break;
case IMAGE_VSPACE:
*vp = INT_TO_JSVAL(image_data->border_vert_space);
break;
case IMAGE_COMPLETE:
*vp = BOOLEAN_TO_JSVAL(image->complete);
break;
default:
/* Don't mess with a user-defined or method property. */
return JS_TRUE;
}
return JS_TRUE;
}
static JSBool
image_set_src(JSImage *image, const char *str, LO_ImageStruct *image_data)
{
MochaDecoder *decoder;
MWContext *context;
IL_GroupContext *img_cx;
decoder = image->decoder;
context = decoder->window_context;
img_cx = decoder->image_context;
if (!context) return JS_TRUE;
image_data->pending_mocha_event = PR_TRUE;
image_data->image_attr->attrmask |= LO_ATTR_MOCHA_IMAGE;
ET_il_GetImage(str, context, img_cx, image_data, NET_DONT_RELOAD);
return JS_TRUE;
}
PR_STATIC_CALLBACK(JSBool)
image_setProperty(JSContext *cx, JSObject *obj, jsval id, jsval *vp)
{
JSBool ok;
JSImage *image;
MochaDecoder *decoder;
MWContext *context;
LO_ImageStruct *image_data;
enum image_slot image_slot;
const char *url;
jsint slot;
image = JS_GetInstancePrivate(cx, obj, &lm_image_class, NULL);
if (!image)
return JS_TRUE;
decoder = image->decoder;
context = decoder->window_context;
if (!context)
return JS_TRUE;
if (!JSVAL_IS_INT(id))
return JS_TRUE;
slot = JSVAL_TO_INT(id);
image_data = GET_IMAGE_DATA(context, image);
if (!image_data)
return JS_TRUE; /* Try to handle this case gracefully. */
image_slot = slot;
switch (image_slot) {
case IMAGE_SRC:
case IMAGE_LOWSRC:
if (!lm_CheckPermissions(cx, obj, JSTARGET_UNIVERSAL_BROWSER_WRITE))
return JS_FALSE;
if (JSVAL_IS_NULL(*vp)) {
url = NULL;
} else {
if (!JSVAL_IS_STRING(*vp) &&
!JS_ConvertValue(cx, *vp, JSTYPE_STRING, vp))
return JS_FALSE;
url = JS_GetStringBytes(JSVAL_TO_STRING(*vp));
url = lm_CheckURL(cx, url, JS_TRUE); /* will allocate new string */
if (!url)
return JS_FALSE;
}
if (image_slot == IMAGE_SRC) {
ok = image_set_src(image, url, image_data);
} else if (url) {
ok = lm_SaveParamString(cx, &image_data->lowres_image_url, url);
}
if (url)
XP_FREE((void *) url);
if (!ok)
return JS_FALSE;
/*
* don't call image_getProperty so that we don't immediately
* turn around and block
*/
return JS_TRUE;
break;
case IMAGE_NAME:
case IMAGE_X:
case IMAGE_Y:
case IMAGE_HEIGHT:
case IMAGE_WIDTH:
case IMAGE_BORDER:
case IMAGE_VSPACE:
case IMAGE_HSPACE:
case IMAGE_COMPLETE:
/* These are immutable. */
break;
}
return image_getProperty(cx, obj, id, vp);
}
PR_STATIC_CALLBACK(void)
image_finalize(JSContext *cx, JSObject *obj)
{
JSImage *image;
LO_ImageStruct *image_data;
MochaDecoder *decoder;
MWContext *context;
image = JS_GetPrivate(cx, obj);
if (!image)
return;
image_data = image->image_data;
decoder = image->decoder;
context = decoder->window_context;
if (image_data) {
/* If this is a layer background image or a reflection of an
existing layout image, then layout will take care of
destroying the image. For anonymous images, however,
we need to handle destruction here. */
if (!image_data->layer) {
ET_PostFreeImageElement(context, image_data);
XP_FREE(image_data->image_attr);
XP_FREE(image_data);
}
} else {
if (context) {
LO_LockLayout();
image_data = LO_GetImageByIndex(context, image->layer_id,
image->index);
if (image_data && image_data->mocha_object == obj)
image_data->mocha_object = NULL;
LO_UnlockLayout();
}
}
DROP_BACK_COUNT(decoder);
JS_UnlockGCThing(cx, image->name);
JS_free(cx, image);
}
JSClass lm_image_class = {
"Image", JSCLASS_HAS_PRIVATE,
JS_PropertyStub, JS_PropertyStub, image_getProperty, image_setProperty,
JS_EnumerateStub, JS_ResolveStub, JS_ConvertStub, image_finalize
};
/* Fill in native, private part of JS image */
static JSImage *
init_image_object(JSContext *cx, JSObject *obj, LO_ImageStruct *image_data)
{
JSImage *image;
MochaDecoder *decoder;
image = JS_malloc(cx, sizeof *image);
if (!image)
return NULL;
XP_BZERO(image, sizeof *image);
image->image_data = image_data;
decoder = JS_GetPrivate(cx, JS_GetGlobalObject(cx));
image->decoder = HOLD_BACK_COUNT(decoder);
image_data->mocha_object = obj;
/* Events are never blocked for anonymous images
since there is no associated layout. */
image->pending_events = PR_BIT(LM_IMGUNBLOCK);
if (!JS_SetPrivate(cx, obj, image))
return NULL;
return image;
}
JSObject *
lm_NewImage(JSContext *cx,
LO_ImageStruct *image_data)
{
JSObject *obj, *outer_obj;
MochaDecoder *decoder;
decoder = JS_GetPrivate(cx, JS_GetGlobalObject(cx));
outer_obj = lm_GetOuterObject(decoder);
obj = JS_NewObject(cx, &lm_image_class, decoder->image_prototype,
outer_obj);
if (!init_image_object(cx, obj, image_data))
return NULL;
return obj;
}
PR_STATIC_CALLBACK(JSBool)
Image(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval)
{
jsint width, height;
LO_ImageStruct *image_data;
XP_ASSERT(JS_InstanceOf(cx, obj, &lm_image_class, NULL));
height = width = 0;
if (argc > 0) {
if (argc != 2) {
JS_ReportError(cx, lm_argc_err_str);
return JS_FALSE;
}
if (!JSVAL_IS_INT(argv[0]) ||
!JSVAL_IS_INT(argv[1])) {
return JS_FALSE;
}
width = JSVAL_TO_INT(argv[0]);
height = JSVAL_TO_INT(argv[1]);
}
/* Allocate dummy layout structure. This is not really
used by layout, but the front-ends and the imagelib
need it as a handle on an image instance. */
image_data = XP_NEW_ZAP(LO_ImageStruct);
if (!image_data) {
JS_ReportOutOfMemory(cx);
return JS_FALSE;
}
image_data->image_attr = XP_NEW_ZAP(LO_ImageAttr);
if (!image_data->image_attr) {
XP_FREE(image_data);
JS_ReportOutOfMemory(cx);
return JS_FALSE;
}
image_data->type = LO_IMAGE;
/* Fake layout ID, guaranteed not to match any real layout element */
image_data->ele_id = -1;
if (!init_image_object(cx, obj, image_data)) {
XP_FREE(image_data->image_attr);
XP_FREE(image_data);
return JS_FALSE;
}
/* Process arguments */
/* Width & Height */
if (argc == 2) {
image_data->width = (int)width;
image_data->height = (int)height;
}
return JS_TRUE;
}
static JSObject *
reflect_image_array(MochaDecoder *decoder, JSObject *document)
{
JSContext *cx;
JSObjectArray *array;
JSObject *obj;
JSDocument *doc;
cx = decoder->js_context;
doc = JS_GetPrivate(cx, document);
if (!doc)
return NULL;
array = JS_malloc(cx, sizeof *array);
if (!array)
return NULL;
XP_BZERO(array, sizeof *array);
obj = JS_NewObject(cx, &lm_image_array_class, NULL, document);
if (!obj || !JS_SetPrivate(cx, obj, array)) {
LM_PutMochaDecoder(decoder);
return NULL;
}
if (!JS_DefineProperties(cx, obj, image_array_props))
return NULL;
array->decoder = HOLD_BACK_COUNT(decoder);
array->layer_id = doc->layer_id;
return obj;
}
JSObject *
lm_GetImageArray(MochaDecoder *decoder, JSObject *document)
{
JSObject *obj;
JSDocument *doc;
doc = JS_GetPrivate(decoder->js_context, document);
if (!doc)
return NULL;
obj = doc->images;
if (obj)
return obj;
obj = reflect_image_array(decoder, document);
doc->images = obj;
return obj;
}
JSObject *
LM_ReflectImage(MWContext *context, LO_ImageStruct *image_data,
PA_Tag * tag, int32 layer_id, uint index)
{
JSObject *obj, *array_obj, *outer_obj, *document;
MochaDecoder *decoder;
JSContext *cx;
JSImage *image;
PA_Block name = NULL;
lo_TopState *top_state;
PRHashTable *map;
image_data = LO_GetImageByIndex(context, layer_id, index);
XP_ASSERT(image_data);
if (! image_data)
return NULL;
obj = image_data->mocha_object;
if (obj)
return obj;
decoder = LM_GetMochaDecoder(context);
if (!decoder)
return NULL;
cx = decoder->js_context;
top_state = lo_GetMochaTopState(context);
if (top_state->resize_reload) {
map = lm_GetIdToObjectMap(decoder);
if (map)
obj = (JSObject *)PR_HashTableLookup(map,
LM_GET_MAPPING_KEY(LM_IMAGES, layer_id, index));
if (obj) {
image_data->mocha_object = obj;
goto done;
}
}
/* Get the document object that will hold this link */
document = lm_GetDocumentFromLayerId(decoder, layer_id);
if (!document)
goto done;
array_obj = lm_GetImageArray(decoder, document);
if (!array_obj)
goto done;
image = JS_malloc(cx, sizeof *image);
if (!image)
goto done;
XP_BZERO(image, sizeof *image);
/* if we got a tag passed in try to get the name out of there */
name = lo_FetchParamValue(context, tag, PARAM_NAME);
outer_obj = lm_GetOuterObject(decoder);
obj = JS_NewObject(cx, &lm_image_class, decoder->image_prototype,
outer_obj);
if (!obj || !JS_SetPrivate(cx, obj, image)) {
JS_free(cx, image);
goto done;
}
if (name) {
JSObject *doc_obj;
extern JSClass lm_form_class;
if (!JS_DefineProperty(cx, outer_obj, (const char *) name,
OBJECT_TO_JSVAL(obj), NULL, NULL,
JSPROP_ENUMERATE|JSPROP_READONLY)) {
obj = NULL;
goto done;
}
/* XXX backward compatibility with 3.0 bug: lo_BlockedImageLayout
would eagerly reflect images outside of any active form, so
they'd end up in document scope. */
if (JS_GetClass(cx, outer_obj) == &lm_form_class &&
(doc_obj = JS_GetParent(cx, outer_obj)) != NULL &&
!JS_DefineProperty(cx, doc_obj, (const char *) name,
OBJECT_TO_JSVAL(obj), NULL, NULL,
JSPROP_ENUMERATE|JSPROP_READONLY)) {
obj = NULL;
goto done;
}
}
image->decoder = HOLD_BACK_COUNT(decoder);
image->index = index;
image->layer_id = layer_id;
image->name = JS_NewStringCopyZ(cx, (const char *) name);
if (!JS_LockGCThing(cx, image->name)) {
obj = NULL;
goto done;
}
image_data->mocha_object = obj;
if (!lm_AddObjectToArray(cx, array_obj, (const char *) name,
index, obj)) {
obj = NULL;
goto done;
}
/* Put it in the index to object hash table */
map = lm_GetIdToObjectMap(decoder);
if (map)
PR_HashTableAdd(map,
LM_GET_MAPPING_KEY(LM_IMAGES, layer_id, index),
obj);
/* OK, we've got our image, see if there are any event handlers
* defined with it
*/
if(tag) {
PA_Block onload = lo_FetchParamValue(context, tag, PARAM_ONLOAD);
PA_Block onabort = lo_FetchParamValue(context, tag, PARAM_ONABORT);
PA_Block onerror = lo_FetchParamValue(context, tag, PARAM_ONERROR);
PA_Block onmousedown = lo_FetchParamValue(context, tag, PARAM_ONMOUSEDOWN);
PA_Block onmouseup = lo_FetchParamValue(context, tag, PARAM_ONMOUSEUP);
PA_Block id = lo_FetchParamValue(context, tag, PARAM_ID);
/* don't hold the layout lock across compiles */
LO_UnlockLayout();
if (onload != NULL) {
(void) lm_CompileEventHandler(decoder, id, tag->data,
tag->newline_count, obj,
PARAM_ONLOAD, onload);
PA_FREE(onload);
}
if (onabort != NULL) {
(void) lm_CompileEventHandler(decoder, id, tag->data,
tag->newline_count, obj,
PARAM_ONABORT, onabort);
PA_FREE(onabort);
}
if (onerror != NULL) {
(void) lm_CompileEventHandler(decoder, id, tag->data,
tag->newline_count, obj,
PARAM_ONERROR, onerror);
PA_FREE(onerror);
}
if (onmousedown != NULL) {
(void) lm_CompileEventHandler(decoder, id, tag->data,
tag->newline_count, obj,
PARAM_ONMOUSEDOWN, onmousedown);
PA_FREE(onmousedown);
}
if (onmouseup != NULL) {
(void) lm_CompileEventHandler(decoder, id, tag->data,
tag->newline_count, obj,
PARAM_ONMOUSEUP, onmouseup);
PA_FREE(onmouseup);
}
if (id)
PA_FREE(id);
LO_LockLayout();
}
done:
if(name)
PA_FREE(name);
LM_PutMochaDecoder(decoder);
return obj;
}
void
lm_ProcessImageEvent(MWContext *context, JSObject *obj,
LM_ImageEvent event)
{
uint event_mask;
jsval result;
JSImage *image;
image = JS_GetPrivate(context->mocha_context, obj);
if (!image)
return;
image->pending_events |= PR_BIT(event);
/* Special event used to trigger deferred events */
if (! (image->pending_events & PR_BIT(LM_IMGUNBLOCK)))
return;
for (event = LM_IMGLOAD; event <= LM_LASTEVENT; event++) {
event_mask = PR_BIT(event);
if (image->pending_events & event_mask) {
JSEvent *pEvent;
pEvent=XP_NEW_ZAP(JSEvent);
image->pending_events &= ~event_mask;
switch (event) {
case LM_IMGLOAD:
pEvent->type = EVENT_LOAD;
image->complete = JS_TRUE;
break;
case LM_IMGABORT:
pEvent->type = EVENT_ABORT;
image->complete = JS_TRUE;
break;
case LM_IMGERROR:
pEvent->type = EVENT_ERROR;
image->complete = JS_TRUE;
break;
default:
XP_ABORT(("Unknown image event"));
}
lm_SendEvent(context, obj, pEvent, &result);
}
}
}
JSBool
lm_InitImageClass(MochaDecoder *decoder)
{
JSContext *cx;
JSObject *prototype;
cx = decoder->js_context;
prototype = JS_InitClass(cx, decoder->window_object,
decoder->event_receiver_prototype, &lm_image_class,
Image, 0, image_props, NULL, NULL, NULL);
if (!prototype)
return JS_FALSE;
decoder->image_prototype = prototype;
return JS_TRUE;
}
/* Create an image context for anonymous images and attach it to the specified
mocha decoder. */
JSBool
lm_NewImageContext(MWContext *context, MochaDecoder *decoder)
{
IL_GroupContext *img_cx;
IMGCB* img_cb;
JMCException *exc = NULL;
if (!decoder->image_context) {
img_cb = IMGCBFactory_Create(&exc); /* JMC Module */
if (exc) {
JMC_DELETE_EXCEPTION(&exc); /* XXX Should really return
exception */
JS_ReportOutOfMemory(decoder->js_context);
return JS_FALSE;
}
/* Create an Image Group Context. IL_NewGroupContext augments the
reference count for the JMC callback interface. The opaque argument
to IL_NewGroupContext is the Front End's display context, which will
be passed back to all the Image Library's FE callbacks. */
img_cx = IL_NewGroupContext((void*)context, (IMGCBIF *)img_cb);
if (!img_cx) {
JS_ReportOutOfMemory(decoder->js_context);
return JS_FALSE;
}
/* Attach the IL_GroupContext to the mocha decoder. */
decoder->image_context = img_cx;
/* Allow the context to observe the decoder's image context. */
ET_il_SetGroupObserver(context, decoder->image_context, context, JS_TRUE);
}
return JS_TRUE;
}

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,287 @@
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* The contents of this file are subject to the Netscape Public License
* Version 1.0 (the "NPL"); you may not use this file except in
* compliance with the NPL. You may obtain a copy of the NPL at
* http://www.mozilla.org/NPL/
*
* Software distributed under the NPL is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
* for the specific language governing rights and limitations under the
* NPL.
*
* The Initial Developer of this code under the NPL is Netscape
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
* Reserved.
*/
/*
* lm_trggr.c
*
* Reflects AutoInstall trigger methods
* into the global JavaScript config object.
*
* See Trigger.java for related functions.
*/
#include "lm.h"
#include "prefapi.h"
#include "VerReg.h"
#include "softupdt.h"
#include "gui.h" /* XP_AppPlatform */
JSBool PR_CALLBACK asd_Version(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval);
JSBool PR_CALLBACK asd_get_version(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval);
JSBool PR_CALLBACK asd_start_update(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval);
JSBool PR_CALLBACK asd_conditional_update(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval);
JSBool PR_CALLBACK asd_alert(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval);
JSBool PR_CALLBACK asd_platform(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval);
PRIVATE JSFunctionSpec autoinstall_methods[] = {
{ "getVersion", asd_get_version, 2 },
{ "startUpdate", asd_start_update, 2 },
{ "conditionalUpdate", asd_conditional_update, 4 },
{ "startUpdateComponent", asd_conditional_update, 4 }, /* old name */
{ NULL, NULL, 0 }
};
PRIVATE JSFunctionSpec globalconfig_methods[] = {
{ "alert", asd_alert, 1 },
{ "getPlatform", asd_platform, 0 },
{ NULL, NULL, 0 }
};
PRIVATE JSClass autoinstall_class = {
"AutoInstall", 0,
JS_PropertyStub, JS_PropertyStub, JS_PropertyStub, JS_PropertyStub,
JS_EnumerateStub, JS_ResolveStub, JS_ConvertStub, JS_FinalizeStub
};
PRIVATE JSClass version_class = {
"VersionInfo", 0,
JS_PropertyStub, JS_PropertyStub, JS_PropertyStub, JS_PropertyStub,
JS_EnumerateStub, JS_ResolveStub, JS_ConvertStub, JS_FinalizeStub
};
JSBool lm_DefineTriggers()
{
JSContext *globalContext = NULL;
JSObject *globalObject = NULL;
JSObject *autoInstallObject, *versionObject;
JSBool ans;
/* get global mocha context and object */
PREF_GetConfigContext(&globalContext);
PREF_GetGlobalConfigObject(&globalObject);
if (globalContext == NULL || globalObject == NULL) {
return JS_FALSE;
}
JS_BeginRequest(globalContext);
/* define AutoInstall object in global object */
autoInstallObject = JS_DefineObject(globalContext, globalObject,
"AutoInstall",
&autoinstall_class,
NULL,
JSPROP_ENUMERATE|JSPROP_READONLY);
if (!autoInstallObject) {
JS_EndRequest(globalContext);
return JS_FALSE;
}
/* define Version class in AutoInstall */
versionObject = JS_InitClass(globalContext, autoInstallObject, NULL,
&version_class, asd_Version, 0, NULL, NULL, NULL, NULL);
if (!versionObject) {
JS_EndRequest(globalContext);
return JS_FALSE;
}
/* define some global config utility functions */
JS_DefineFunctions(globalContext, globalObject, globalconfig_methods);
ans = JS_DefineFunctions(globalContext, autoInstallObject,
autoinstall_methods);
JS_EndRequest(globalContext);
return ans;
}
/* Convert VERSION type to Version JS object */
static void asd_versToObj(JSContext *cx, VERSION* vers, JSObject* versObj)
{
jsval val = INT_TO_JSVAL(vers->major);
JS_SetProperty(cx, versObj, "major", &val);
val = INT_TO_JSVAL(vers->minor);
JS_SetProperty(cx, versObj, "minor", &val);
val = INT_TO_JSVAL(vers->release);
JS_SetProperty(cx, versObj, "release", &val);
val = INT_TO_JSVAL(vers->build);
JS_SetProperty(cx, versObj, "build", &val);
}
/* Convert Version JS object to VERSION type */
static void asd_objToVers(JSContext *cx, JSObject* versObj, VERSION* vers)
{
jsval val;
JS_GetProperty(cx, versObj, "major", &val);
vers->major = JSVAL_TO_INT(val);
JS_GetProperty(cx, versObj, "minor", &val);
vers->minor = JSVAL_TO_INT(val);
JS_GetProperty(cx, versObj, "release", &val);
vers->release = JSVAL_TO_INT(val);
JS_GetProperty(cx, versObj, "build", &val);
vers->build = JSVAL_TO_INT(val);
}
/*
* ?? -- move this to VR?
* Returns 0 if versions are equal; < 0 if vers2 is newer; > 0 if vers1 is newer
*/
static int asd_compareVersion(VERSION* vers1, VERSION* vers2)
{
int diff;
if (vers1 == NULL)
diff = -4;
else if (vers2 == NULL)
diff = 4;
else if (vers1->major == vers2->major) {
if (vers1->minor == vers2->minor) {
if (vers1->release == vers2->release) {
if (vers1->build == vers2->build)
diff = 0;
else diff = (vers1->build > vers2->build) ? 1 : -1;
}
else diff = (vers1->release > vers2->release) ? 2 : -2;
}
else diff = (vers1->minor > vers2->minor) ? 3 : -3;
}
else diff = (vers1->major > vers2->major) ? 4 : -4;
return diff;
}
/* Version constructor
(accepts up to four int params to initialize fields) */
JSBool PR_CALLBACK asd_Version
(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval)
{
VERSION vers;
vers.major = (argc >= 1 && JSVAL_IS_INT(argv[0])) ? JSVAL_TO_INT(argv[0]) : 0;
vers.minor = (argc >= 2 && JSVAL_IS_INT(argv[1])) ? JSVAL_TO_INT(argv[1]) : 0;
vers.release = (argc >= 3 && JSVAL_IS_INT(argv[2])) ? JSVAL_TO_INT(argv[2]) : 0;
vers.build = (argc >= 4 && JSVAL_IS_INT(argv[3])) ? JSVAL_TO_INT(argv[3]) : 0;
asd_versToObj(cx, &vers, obj);
return JS_TRUE;
}
/* arguments:
0. component name
1. version no. to fill in
return:
error status */
JSBool PR_CALLBACK asd_get_version
(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval)
{
REGERR status = 0;
if (argc >= 2 && JSVAL_IS_STRING(argv[0])
&& JSVAL_IS_OBJECT(argv[1]))
{
VERSION vers;
char* component_path = JS_GetStringBytes(JSVAL_TO_STRING(argv[0]));
status = VR_GetVersion(component_path, &vers);
if (status == REGERR_OK) {
JSObject* versObj = JSVAL_TO_OBJECT(argv[1]);
asd_versToObj(cx, &vers, versObj);
}
}
*rval = INT_TO_JSVAL(status);
return JS_TRUE;
}
/* arguments:
0. url
1. flags
return:
true if no errors */
JSBool PR_CALLBACK asd_start_update
(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval)
{
if (argc >= 2 && JSVAL_IS_STRING(argv[0]) &&
JSVAL_IS_INT(argv[1])) {
char* url = JS_GetStringBytes(JSVAL_TO_STRING(argv[0]));
/* Bookmarks is a hack, you should really get some SmartUpdate context */
MWContext* cx = XP_FindContextOfType(NULL, MWContextBookmarks);
XP_Bool result = SU_StartSoftwareUpdate( cx, url,
NULL, NULL, NULL, JSVAL_TO_INT(argv[1]) );
*rval = BOOLEAN_TO_JSVAL(result);
return JS_TRUE;
}
*rval = BOOLEAN_TO_JSVAL(JS_FALSE);
return JS_TRUE;
}
/* arguments:
0. url
1. component name
2. version no. to compare
3. flags
return:
true if update triggered and no errors */
JSBool PR_CALLBACK asd_conditional_update
(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval)
{
REGERR status = 0;
if (argc >= 4 && JSVAL_IS_STRING(argv[0]) &&
JSVAL_IS_STRING(argv[1]) &&
JSVAL_IS_OBJECT(argv[2]) &&
JSVAL_IS_INT(argv[3]))
{
VERSION curr_vers;
char* component_path = JS_GetStringBytes(JSVAL_TO_STRING(argv[1]));
status = VR_GetVersion(component_path, &curr_vers);
if (status == REGERR_OK) {
JSObject* versObj = JSVAL_TO_OBJECT(argv[2]);
VERSION req_vers;
asd_objToVers(cx, versObj, &req_vers);
if ( asd_compareVersion(&req_vers, &curr_vers) > 0 ) {
char* url = JS_GetStringBytes(JSVAL_TO_STRING(argv[0]));
MWContext* cx = XP_FindContextOfType(NULL, MWContextBookmarks);
XP_Bool result = SU_StartSoftwareUpdate( cx, url,
NULL, NULL, NULL, JSVAL_TO_INT(argv[3]) );
*rval = BOOLEAN_TO_JSVAL(result);
return JS_TRUE;
}
}
}
*rval = BOOLEAN_TO_JSVAL(JS_FALSE); /*INT_TO_JSVAL(status);*/
return JS_TRUE;
}
JSBool PR_CALLBACK asd_alert
(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval)
{
if (argc >= 1 && JSVAL_IS_STRING(argv[0])) {
char* msg = JS_GetStringBytes(JSVAL_TO_STRING(argv[0]));
MWContext* ctx = XP_FindSomeContext();
if (ctx)
FE_Alert(ctx, msg);
}
return JS_TRUE;
}
JSBool PR_CALLBACK asd_platform
(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval)
{
*rval = STRING_TO_JSVAL( JS_NewStringCopyZ(cx, XP_AppPlatform) );
return JS_TRUE;
}

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,425 @@
/*
* lm_wngrp.c: Structures and functions to deal with new LM window groups
* and multiple LM threads and what not.
*
* All blame to Mike McCool (mlm@netscape.com) 2/17/98
*/
#include "lm.h"
#include "xp.h"
#include "prclist.h"
#include "prthread.h"
#include "prmon.h"
#ifdef XP_MAC
#include "pprthred.h" /* for PR_CreateThreadGCAble */
#else
#include "private/pprthred.h"
#endif
/*
* Notes to self
*
* - lm_window_count: do we care that there's only one?
* - do we need to add a limit to number of threads we spawn()?
* - JRIEnv: do we need multiple?
* - JSRuntime: do we need multiple?
* - Threading changes: impact on debugger?
* - JS_SetGlobalObject(JSContext) will be important
* - If the global structure is on the mozilla thread, can other threads
* creating a new thread group access, or do I have to post an event?
*
* ? Rename "MochaDecoder" to "LMWindow"
* ? Change so that there is only one JSContext
*/
PRMonitor *wingroups_mon;
LMWindowGroup *wingroups;
PRMonitor *request_mon;
struct ContextListStr {
ContextList *next;
ContextList *prev;
MWContext *context;
};
LMWindowGroup *_lm_NewWindowGroup(int priority);
/* Initialize my globals, from the Mozilla thread
*/
void lm_InitWindowGroups(void)
{
int priority;
/* run at slightly lower priority than the mozilla thread */
priority = PR_GetThreadPriority(PR_CurrentThread());
PR_ASSERT(priority >= PR_PRIORITY_FIRST && priority <= PR_PRIORITY_LAST);
if (priority == PR_PRIORITY_NORMAL)
priority = PR_PRIORITY_LOW;
else if (priority == PR_PRIORITY_HIGH)
priority = PR_PRIORITY_NORMAL;
else if (priority == PR_PRIORITY_URGENT)
priority = PR_PRIORITY_HIGH;
else
priority = PR_PRIORITY_LOW;
wingroups_mon = PR_NewMonitor();
request_mon = PR_NewMonitor();
wingroups = NULL;
wingroups = _lm_NewWindowGroup(priority);
if(wingroups != NULL) {
PR_INIT_CLIST(wingroups);
lm_StartWindowGroup(wingroups);
} /* else huh?! */
}
/* Create a new window group. Create new context, create new monitor, create
* new thread, event queue, queue stack, empty context list.
*/
LMWindowGroup *lm_NewWindowGroup(void)
{
int priority;
/* Run at same priority as current thread (which should be a JS
* thread.
*/
priority = PR_GetThreadPriority(PR_CurrentThread());
PR_ASSERT(priority>=PR_PRIORITY_FIRST && priority<=PR_PRIORITY_LAST);
return _lm_NewWindowGroup(priority);
}
LMWindowGroup *_lm_NewWindowGroup(int priority)
{
LMWindowGroup *newgrp = XP_NEW_ZAP(LMWindowGroup);
if(newgrp != NULL) {
newgrp->done = PR_FALSE;
newgrp->hasLock = PR_FALSE;
/* Create a new JS Context for this set of windows.
* Note: Need to get global runtime lm_runtime from somewhere,
* and perhaps the LM_STACK_SIZE?
*/
/**************************************************** MLM *
newgrp->js_context = JS_NewContext(lm_runtime, LM_STACK_SIZE);
if(newgrp->js_context == NULL) {
XP_DELETE(newgrp);
return NULL;
}
**************************************************** MLM */
newgrp->js_context = NULL;
/* JS_SetGCCallback(newgrp->js_context, LM_ShouldRunGC); */
newgrp->mw_contexts = XP_NEW_ZAP(ContextList);
if(newgrp->mw_contexts == NULL) {
JS_DestroyContext(newgrp->js_context);
XP_DELETE(newgrp);
return NULL;
}
PR_INIT_CLIST(newgrp->mw_contexts);
newgrp->mw_contexts->context = NULL;
newgrp->current_context = NULL;
newgrp->queue_stack = XP_NEW_ZAP(QueueStackElement);
if(!newgrp->queue_stack) {
JS_DestroyContext(newgrp->js_context);
XP_DELETE(newgrp->mw_contexts);
XP_DELETE(newgrp);
return NULL;
}
/* Do this here so we don't race ourselves in lm_wait_for_events */
PR_EnterMonitor(wingroups_mon);
if(wingroups != NULL) {
PR_APPEND_LINK(newgrp, wingroups);
}
PR_ExitMonitor(wingroups_mon);
newgrp->waiting_list = NULL;
newgrp->owner_monitor = PR_NewMonitor();
newgrp->queue_monitor = PR_NewMonitor();
PR_EnterMonitor(newgrp->owner_monitor);
newgrp->thread = PR_CreateThreadGCAble(PR_USER_THREAD,
lm_wait_for_events, newgrp,
priority, PR_LOCAL_THREAD,
PR_UNJOINABLE_THREAD, 0);
newgrp->owner = newgrp->thread;
newgrp->current_count = 0;
newgrp->mozWantsLock = PR_FALSE;
newgrp->mozGotLock = PR_FALSE;
newgrp->interruptCurrentOp = PR_FALSE;
newgrp->queue_depth = 0;
newgrp->queue_count = 0;
/* Note: Need a unique identifier for this queue?
*/
newgrp->interpret_queue = PR_CreateEventQueue("new_event_queue",
newgrp->thread);
newgrp->queue_stack->queue = newgrp->interpret_queue;
newgrp->lock_context = NULL;
newgrp->js_timeout_insertion_point = NULL;
newgrp->js_timeout_running = NULL;
newgrp->inputRecurring = 0;
}
return newgrp;
}
void lm_StartWindowGroup(LMWindowGroup *grp)
{
PR_Notify(grp->owner_monitor);
PR_ExitMonitor(grp->owner_monitor);
}
void lm_DestroyWindowGroup(LMWindowGroup *grp)
{
PR_EnterMonitor(wingroups_mon);
/* Note: Thread terminates when the thread's main function (in
* this case, lm_wait_for_events) exits.
*/
/************************************ MLM *
* JS_DestroyContext(grp->js_context);
************************************ MLM */
PR_DestroyMonitor(grp->owner_monitor);
PR_DestroyMonitor(grp->queue_monitor);
/* Note: How to destroy an event queue or two?
*/
/* Note: Context list should already be null
*/
PR_REMOVE_LINK(grp);
XP_DELETE(grp);
PR_ExitMonitor(wingroups_mon);
}
LMWindowGroup *LM_GetDefaultWindowGroup(MWContext *mwc)
{
LMWindowGroup *ans;
/* Check to see if this is a frame context. If so, check its parent. */
if((mwc != NULL) && (mwc->is_grid_cell)) {
MWContext *grid_parent, *grid_child;
grid_child = mwc;
grid_parent = mwc->grid_parent;
/* Find the root parent. I wonder if I need to add cycle checking. */
while(grid_parent != NULL) {
grid_child = grid_parent;
grid_parent = grid_child->grid_parent;
}
if( (ans = lm_MWContextToGroup(grid_child)) != NULL) {
/* The parent's been found, return its group. */
return ans;
} else { /* Else add the parent to the default group,
* and return that. */
PR_EnterMonitor(wingroups_mon);
LM_AddContextToGroup(wingroups, grid_child);
ans = wingroups;
PR_ExitMonitor(wingroups_mon);
return ans;
}
}
PR_EnterMonitor(wingroups_mon);
ans = wingroups;
PR_ExitMonitor(wingroups_mon);
return ans;
}
LMWindowGroup *lm_MWContextToGroup(MWContext *mwc)
{
LMWindowGroup *ptr = NULL;
LMWindowGroup *ans = NULL;
PR_EnterMonitor(wingroups_mon);
ptr = wingroups;
if(lm_GetEntryForContext(wingroups, mwc) != NULL) {
ans = wingroups;
PR_ExitMonitor(wingroups_mon);
return ans;
}
ptr = PR_NEXT_LINK(ptr);
while(ptr != wingroups) {
if(lm_GetEntryForContext(ptr, mwc) != NULL) {
ans = ptr;
PR_ExitMonitor(wingroups_mon);
return ans;
}
ptr = PR_NEXT_LINK(ptr);
}
PR_ExitMonitor(wingroups_mon);
return NULL;
}
LMWindowGroup *lm_QueueStackToGroup(QueueStackElement *qse)
{
LMWindowGroup *ptr = NULL;
LMWindowGroup *ans = NULL;
PR_EnterMonitor(wingroups_mon);
ptr = wingroups;
if(wingroups->queue_stack == qse) {
ans = wingroups;
PR_ExitMonitor(wingroups_mon);
return ans;
}
ptr = PR_NEXT_LINK(ptr);
while(ptr != wingroups) {
if(ptr->queue_stack == qse) {
ans = ptr;
PR_ExitMonitor(wingroups_mon);
return ans;
}
ptr = PR_NEXT_LINK(ptr);
}
PR_ExitMonitor(wingroups_mon);
return NULL;
}
PREventQueue *LM_MWContextToQueue(MWContext *mwc)
{
/* Note: This gets the interpret queue, need to get top queue as well
*/
LMWindowGroup *grp = lm_MWContextToGroup(mwc);
if(grp != NULL) {
return LM_WindowGroupToQueue(grp);
}
return NULL;
}
PREventQueue *LM_WindowGroupToQueue(LMWindowGroup *lmg)
{
return lmg->interpret_queue;
}
ContextList *lm_GetEntryForContext(LMWindowGroup *grp, MWContext *cx)
{
ContextList *cxl = grp->mw_contexts;
ContextList *ans = NULL;
if(PR_CLIST_IS_EMPTY(cxl)) {
return NULL;
} else {
ContextList *ptr = PR_NEXT_LINK(cxl);
while(ptr != cxl) {
if(ptr->context == cx) {
ans = ptr;
break;
}
ptr = PR_NEXT_LINK(ptr);
}
}
return ans;
}
void LM_AddContextToGroup(LMWindowGroup *grp, MWContext *cx)
{
ContextList *cxl;
if(lm_MWContextToGroup(cx) != NULL) {
/* Hey, why are we adding this stuff twice? */
XP_ASSERT(0);
}
cxl = XP_NEW_ZAP(ContextList);
/* Note: failure?!?!?!
*/
cxl->context = cx;
PR_APPEND_LINK(cxl, grp->mw_contexts);
}
void lm_RemoveContextFromGroup(LMWindowGroup *grp, MWContext *cx);
void LM_RemoveContextFromGroup(MWContext *cx)
{
LMWindowGroup *grp = lm_MWContextToGroup(cx);
if(grp) {
lm_RemoveContextFromGroup(grp, cx);
}
}
void lm_RemoveContextFromGroup(LMWindowGroup *grp, MWContext *cx)
{
if(!PR_CLIST_IS_EMPTY(grp->mw_contexts)) {
ContextList *entry = lm_GetEntryForContext(grp, cx);
if(entry != NULL) {
PR_REMOVE_LINK(entry);
XP_DELETE(entry);
}
}
if(PR_CLIST_IS_EMPTY(grp->mw_contexts) && (grp != wingroups)) {
grp->done = PR_TRUE;
}
}
PRBool LM_IsLocked(LMWindowGroup *grp)
{
PRBool ans;
PR_EnterMonitor(request_mon);
ans = grp->hasLock;
PR_ExitMonitor(request_mon);
return ans;
}
void LM_BeginRequest(LMWindowGroup *grp, JSContext *jsc)
{
PR_EnterMonitor(request_mon);
grp->hasLock = PR_TRUE;
grp->lock_context = jsc;
if((JS_GetContextThread(jsc)) != ((intN) grp->thread)) {
JS_SetContextThread(jsc);
}
PR_ExitMonitor(request_mon);
JS_BeginRequest(jsc);
}
void LM_EndRequest(LMWindowGroup *grp, JSContext *jsc)
{
JS_EndRequest(jsc);
PR_EnterMonitor(request_mon);
grp->lock_context = NULL;
grp->hasLock = PR_FALSE;
PR_ExitMonitor(request_mon);
}
JSBool LM_ShouldRunGC(JSContext *cx, JSGCStatus status)
{
JSBool ans = JS_TRUE;
JSContext *active;
LMWindowGroup *ptr;
if(status != JSGC_BEGIN) {
return JS_TRUE;
}
PR_EnterMonitor(request_mon);
if(wingroups->hasLock) {
active = wingroups->lock_context;
if(active != cx) {
ans=JS_FALSE;
goto bye;
}
}
ptr = PR_NEXT_LINK(wingroups);
while(ptr != wingroups) {
if(ptr->hasLock) {
active = ptr->lock_context;
if(active != cx) {
ans=JS_FALSE;
goto bye;
}
}
ptr = PR_NEXT_LINK(ptr);
}
bye:
PR_ExitMonitor(request_mon);
return ans;
}

View File

@@ -0,0 +1,617 @@
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* The contents of this file are subject to the Netscape Public License
* Version 1.0 (the "NPL"); you may not use this file except in
* compliance with the NPL. You may obtain a copy of the NPL at
* http://www.mozilla.org/NPL/
*
* Software distributed under the NPL is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
* for the specific language governing rights and limitations under the
* NPL.
*
* The Initial Developer of this code under the NPL is Netscape
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
* Reserved.
*/
/*
jscookie.c -- javascript reflection of cookies for filters.
Created: Frederick G.M. Roeber <roeber@netscape.com>, 12-Jul-97.
Adopted: Judson Valeski, 1997.
Large chunks of this were stolen from jsmsg.c.
*/
#include "mkutils.h"
#include "mkutils.h"
#include "mkparse.h"
#include "mkaccess.h"
#include "prefapi.h"
#include "jsapi.h"
#include "xp_core.h"
#include "xp_mcom.h"
#include "jscookie.h"
#include "ds.h"
#include "htmldlgs.h"
#include "xpgetstr.h"
extern int MK_ACCESS_JAVASCRIPT_COOKIE_FILTER;
static JSObject *filter_obj = NULL;
static JSContext *filter_context = NULL;
static JSBool error_reporter_installed = JS_FALSE;
static JSErrorReporter previous_error_reporter;
/* tells us when we should recompile the file. */
static JSBool need_compile = JS_TRUE;
/* This is the private instance data associated with a cookie */
typedef struct JSCookieData {
JSContext *js_context;
JSObject *js_object;
JSCFCookieData *data;
PRPackedBool property_changed, rejected, accepted, ask, decision_made;
} JSCookieData;
/* The properties of a cookie that we reflect */
enum cookie_slot {
COOKIE_PATH = -1,
COOKIE_DOMAIN = -2,
COOKIE_NAME = -3,
COOKIE_VALUE = -4,
COOKIE_EXPIRES = -5,
COOKIE_URL = -6,
COOKIE_IS_SECURE = -7,
COOKIE_IS_DOMAIN = -8,
COOKIE_PROMPT_PREF = -9,
COOKIE_PREF = -10
};
/*
* Should more of these be readonly? What does it mean for a cookie
* to de secure? -chouck
*/
static JSPropertySpec cookie_props[] = {
{ "path", COOKIE_PATH, JSPROP_ENUMERATE },
{ "domain", COOKIE_DOMAIN, JSPROP_ENUMERATE },
{ "name", COOKIE_NAME, JSPROP_ENUMERATE },
{ "value", COOKIE_VALUE, JSPROP_ENUMERATE },
{ "expires", COOKIE_EXPIRES, JSPROP_ENUMERATE },
{ "url", COOKIE_URL, JSPROP_ENUMERATE|JSPROP_READONLY },
{ "isSecure", COOKIE_IS_SECURE, JSPROP_ENUMERATE },
{ "isDomain", COOKIE_IS_DOMAIN, JSPROP_ENUMERATE },
{ "prompt", COOKIE_PROMPT_PREF, JSPROP_ENUMERATE|JSPROP_READONLY },
{ "preference", COOKIE_PREF, JSPROP_ENUMERATE|JSPROP_READONLY },
{ 0 }
};
PR_STATIC_CALLBACK(JSBool)
cookie_getProperty(JSContext *cx, JSObject *obj, jsval id, jsval *vp)
{
JSCookieData *data;
JSString *str;
jsint slot;
data = (JSCookieData *)JS_GetPrivate(cx, obj);
if (!data)
return JS_TRUE;
if (!JSVAL_IS_INT(id))
return JS_TRUE;
slot = JSVAL_TO_INT(id);
switch (slot) {
case COOKIE_PATH:
str = JS_NewStringCopyZ(cx, (const char *)data->data->path_from_header);
if( (JSString *)0 == str )
return JS_FALSE;
*vp = STRING_TO_JSVAL(str);
break;
case COOKIE_DOMAIN:
str = JS_NewStringCopyZ(cx, (const char *)data->data->host_from_header);
if( (JSString *)0 == str )
return JS_FALSE;
*vp = STRING_TO_JSVAL(str);
break;
case COOKIE_NAME:
str = JS_NewStringCopyZ(cx, (const char *)data->data->name_from_header);
if( (JSString *)0 == str )
return JS_FALSE;
*vp = STRING_TO_JSVAL(str);
break;
case COOKIE_VALUE:
str = JS_NewStringCopyZ(cx, (const char *)data->data->cookie_from_header);
if( (JSString *)0 == str )
return JS_FALSE;
*vp = STRING_TO_JSVAL(str);
break;
case COOKIE_EXPIRES:
*vp = INT_TO_JSVAL(data->data->expires);
break;
case COOKIE_URL:
str = JS_NewStringCopyZ(cx, (const char *)data->data->url);
if( (JSString *)0 == str )
return JS_FALSE;
*vp = STRING_TO_JSVAL(str);
break;
case COOKIE_IS_SECURE:
*vp = BOOLEAN_TO_JSVAL(data->data->secure);
break;
case COOKIE_IS_DOMAIN:
*vp = BOOLEAN_TO_JSVAL(data->data->domain);
break;
case COOKIE_PROMPT_PREF:
*vp = BOOLEAN_TO_JSVAL(data->data->prompt);
break;
case COOKIE_PREF:
*vp = INT_TO_JSVAL(data->data->preference);
break;
}
return JS_TRUE;
}
PR_STATIC_CALLBACK(JSBool)
cookie_setProperty(JSContext *cx, JSObject *obj, jsval id, jsval *vp)
{
JSCookieData *data;
jsint slot;
PRInt32 i;
JSBool b;
data = (JSCookieData *)JS_GetPrivate(cx, obj);
if (!data)
return JS_TRUE;
if (!JSVAL_IS_INT(id))
return JS_TRUE;
slot = JSVAL_TO_INT(id);
if (slot == COOKIE_PATH) {
data->data->path_from_header = JS_GetStringBytes(JSVAL_TO_STRING(*vp));
}
else if (slot == COOKIE_DOMAIN) {
data->data->host_from_header = JS_GetStringBytes(JSVAL_TO_STRING(*vp));
}
else if (slot == COOKIE_NAME) {
data->data->name_from_header = JS_GetStringBytes(JSVAL_TO_STRING(*vp));
}
else if (slot == COOKIE_VALUE) {
data->data->cookie_from_header = JS_GetStringBytes(JSVAL_TO_STRING(*vp));
}
else if (slot == COOKIE_EXPIRES) {
if( !JS_ValueToInt32(cx, *vp, (long *)&i) )
return JS_FALSE;
data->data->expires = i;
}
else if (slot == COOKIE_IS_SECURE) {
if( !JS_ValueToBoolean(cx, *vp, &b) )
return JS_FALSE;
data->data->secure = b;
}
else if (slot == COOKIE_IS_DOMAIN) {
if( !JS_ValueToBoolean(cx, *vp, &b) )
return JS_FALSE;
data->data->domain = b;
}
data->property_changed = TRUE;
return JS_TRUE;
}
PR_STATIC_CALLBACK(void)
cookie_finalize(JSContext *cx, JSObject *obj)
{
JSCookieData *cookie;
cookie = JS_GetPrivate(cx, obj);
FREEIF(cookie);
}
/* So we can possibly add functions "global" to filters... */
static JSClass global_class = {
"CookieFilters", 0 /* no private data */,
JS_PropertyStub, JS_PropertyStub, JS_PropertyStub, JS_PropertyStub,
JS_EnumerateStub, JS_ResolveStub, JS_ConvertStub, JS_FinalizeStub
};
static JSClass js_cookie_class = {
"Cookie", JSCLASS_HAS_PRIVATE,
JS_PropertyStub, JS_PropertyStub, cookie_getProperty, cookie_setProperty,
JS_EnumerateStub, JS_ResolveStub, JS_ConvertStub, cookie_finalize
};
/* cookie.accept() -- mark it okay */
PR_STATIC_CALLBACK(JSBool)
cookie_accept(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval * rval)
{
JSCookieData *data;
if (!(data = (JSCookieData*)JS_GetInstancePrivate(cx, obj, &js_cookie_class, argv)))
return JS_FALSE;
data->accepted = TRUE;
data->rejected = FALSE;
data->ask = FALSE;
data->decision_made = TRUE;
return JS_TRUE;
}
/* cookie.reject() -- reject it out of hand */
PR_STATIC_CALLBACK(JSBool)
cookie_reject(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval * rval)
{
JSCookieData *data;
if (!(data = (JSCookieData*)JS_GetInstancePrivate(cx, obj, &js_cookie_class, argv)))
return JS_FALSE;
data->accepted = FALSE;
data->rejected = TRUE;
data->ask = FALSE;
data->decision_made = TRUE;
return JS_TRUE;
}
/* cookie.ask() -- ask the luser, even if that pref is off */
PR_STATIC_CALLBACK(JSBool)
cookie_ask(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval * rval)
{
JSCookieData *data;
if (!(data = (JSCookieData*)JS_GetInstancePrivate(cx, obj, &js_cookie_class, argv)))
return JS_FALSE;
data->accepted = FALSE;
data->rejected = FALSE;
data->ask = TRUE;
data->decision_made = TRUE;
return JS_TRUE;
}
/* cookie.confirm() -- pop up a confirmation box */
PR_STATIC_CALLBACK(JSBool)
cookie_confirm(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval * rval)
{
JSCookieData *data;
JSString *str;
char *msg = (char *)0;
Bool result;
MWContext * context = XP_FindSomeContext();
if (argc < 1 || !context)
return JS_FALSE;
if (!(data = (JSCookieData*)JS_GetInstancePrivate(cx, obj, &js_cookie_class, argv)))
return JS_FALSE;
str = JS_ValueToString(cx, argv[0]);
if (!str)
return JS_FALSE;
StrAllocCopy(msg, XP_GetString(MK_ACCESS_JAVASCRIPT_COOKIE_FILTER));
StrAllocCat(msg, JS_GetStringBytes(str));
if (!msg)
return JS_FALSE;
result = FE_Confirm(context, msg);
FREEIF(msg);
*rval = BOOLEAN_TO_JSVAL(result);
return JS_TRUE;
}
#if DEBUG
/* trace() -- outputs spew to stderr. Actually, this (or something like it
that perhaps outputs to the same file that the rest of the filter logging code
writes to) would probably be very useful in the normal course of writing filters. */
PR_STATIC_CALLBACK(JSBool)
cookie_filter_trace(JSContext *cx, JSObject * obj, uint argc, jsval *argv, jsval * rval)
{
if (argc > 0)
{
JSString *str;
const char *trace_str;
if (!(str = JS_ValueToString(cx, argv[0])))
return JS_FALSE;
trace_str = JS_GetStringBytes(str);
if (*trace_str != '\0')
{
fprintf (stderr, "cookie filter trace: %s\n", trace_str);
}
return JS_TRUE;
}
return JS_FALSE;
}
#endif
static JSFunctionSpec cookie_methods[] = {
{ "accept", cookie_accept, 0 },
{ "reject", cookie_reject, 0 },
{ "ask", cookie_ask, 0 },
{ "confirm", cookie_confirm, 1 },
{ 0 }
};
static JSFunctionSpec filter_methods[] = {
#ifdef DEBUG
{ "trace", cookie_filter_trace, 1 },
#endif
{ 0 }
};
PRIVATE void
destroyJSCookieFilterStuff(void)
{
filter_obj = NULL;
}
/*
* This function used to take an MWContext and store it as the private data
* of the filter object. That is a no-no since the filter_obj is going to
* be around until the end of time but there is no guarentee that the
* context won't get free'd out from under us. The solution is to not
* hold onto any particular context but just call XP_FindSomeContext() or
* some derivative of it when we need to.
*/
PRIVATE JSContext *
initializeJSCookieFilterStuff()
{
/* Only bother initializing once */
if (filter_obj)
return filter_context;
/* If we can't get the mozilla-thread global context just bail */
PREF_GetConfigContext(&filter_context);
if (!filter_context)
return NULL;
JS_BeginRequest(filter_context);
/* create our "global" object. We make the message object a child of this */
filter_obj = JS_NewObject(filter_context, &global_class, NULL, NULL);
/* MLM - don't do JS_InitStandardClasses() twice */
if (!filter_obj
|| !JS_DefineFunctions(filter_context, filter_obj, filter_methods))
{
JS_EndRequest(filter_context);
destroyJSCookieFilterStuff();
return NULL;
}
JS_EndRequest(filter_context);
return filter_context;
}
PRIVATE JSObject *
newCookieObject(void)
{
JSObject *rv;
JSCookieData *cookie_data;
rv = JS_DefineObject(filter_context, filter_obj,
"cookie", &js_cookie_class,
NULL, JSPROP_ENUMERATE);
if( (JSObject *)0 == rv )
return (JSObject *)0;
cookie_data = XP_NEW_ZAP(JSCookieData);
if( (JSCookieData *)0 == cookie_data )
return (JSObject *)0;
if( !JS_SetPrivate(filter_context, rv, cookie_data)
|| !JS_DefineProperties(filter_context, rv, cookie_props)
|| !JS_DefineFunctions(filter_context, rv, cookie_methods)) {
return (JSObject *)0;
}
return rv;
}
PR_STATIC_CALLBACK(void)
jscookie_ErrorReporter(JSContext *cx, const char *message, JSErrorReport *report)
{
char *msg = NULL;
MWContext *context;
context = XP_FindSomeContext();
if(!context || !report)
return;
/*XXX: i18n-ise this */
msg = PR_sprintf_append(NULL,
"JavaScript Cookie Filter Error:\n"
"You will be prompted manually to accept or reject this cookie.\n"
"Filename: %s\n"
"Line #: %u\n"
"%s\n"
"%.*s\n",
report->filename,
report->lineno,
report->linebuf,
(int)(report->tokenptr - report->linebuf) + 1,
"^"
);
if (!msg)
return;
FE_Alert(context, msg);
XP_FREE(msg);
return;
}
PRIVATE JSBool
compileJSCookieFilters(void)
{
static time_t m_time = 0; /* the last modification time of filters.js */
static JSBool ret_val = JS_FALSE;
char *filename;
XP_File fp;
XP_StatStruct stats;
if (!need_compile)
return ret_val;
filename = WH_FileName("", xpJSCookieFilters);
XP_Trace("+Filename for script filter is %s\n", filename);
/* If we can't get to the file, get the hell outa dodge. */
if(XP_Stat(filename, &stats, xpJSCookieFilters))
return ret_val;
if (stats.st_mtime > m_time || need_compile)
{
long fileLength;
char *buffer;
jsval rval;
m_time = stats.st_mtime;
fileLength = stats.st_size;
if (fileLength <= 1)
{
ret_val = JS_FALSE;
return ret_val;
}
if( !(fp = XP_FileOpen(filename, xpJSCookieFilters, "r")) ) {
ret_val = JS_FALSE;
return ret_val;
}
buffer = (char*)malloc(fileLength);
if (!buffer) {
XP_FileClose(fp);
ret_val = JS_FALSE;
return ret_val;
}
fileLength = XP_FileRead(buffer, fileLength, fp);
XP_FileClose(fp);
XP_Trace("+Compiling filters.js...\n");
ret_val = JS_EvaluateScript(filter_context, filter_obj, buffer, fileLength,
filename, 1, &rval);
XP_Trace("+Done.\n");
XP_FREE(buffer);
need_compile = JS_FALSE;
}
return ret_val;
}
PUBLIC JSCFResult
JSCF_Execute(
MWContext *mwcontext,
const char *script_name,
JSCFCookieData *data,
Bool *data_changed
)
{
jsval result;
jsval filter_arg; /* we will this in with the message object we create. */
JSObject *cookie_obj;
JSCookieData *cookie_data;
if (!script_name)
return JSCF_error;
/* initialize the filter stuff, and bomb out early if it fails */
if (!initializeJSCookieFilterStuff())
return JSCF_error;
JS_BeginRequest(filter_context);
/*
* try loading (reloading if necessary) the filter file before bothering
* to create any JS-objects
*/
if (!compileJSCookieFilters()) {
JS_EndRequest(filter_context);
return JSCF_error;
}
if (!error_reporter_installed)
{
error_reporter_installed = JS_TRUE;
previous_error_reporter = JS_SetErrorReporter(filter_context,
jscookie_ErrorReporter);
}
cookie_obj = newCookieObject();
if( (JSObject *)0 == cookie_obj ) {
JS_EndRequest(filter_context);
return JSCF_error;
}
cookie_data = (JSCookieData *)JS_GetPrivate(filter_context, cookie_obj);
cookie_data->js_context = filter_context;
cookie_data->js_object = cookie_obj;
cookie_data->data = data;
cookie_data->property_changed = FALSE;
cookie_data->rejected = FALSE;
cookie_data->accepted = FALSE;
cookie_data->decision_made = FALSE;
filter_arg = OBJECT_TO_JSVAL(cookie_obj);
JS_CallFunctionName(filter_context, filter_obj, script_name, 1,
&filter_arg, &result);
JS_EndRequest(filter_context);
*data_changed = cookie_data->property_changed;
if( cookie_data->decision_made ) {
if( cookie_data->rejected )
return JSCF_reject;
else if( cookie_data->accepted )
return JSCF_accept;
else if( cookie_data->ask )
return JSCF_ask;
}
return JSCF_whatever;
}
PUBLIC void
JSCF_Cleanup(void)
{
TRACEMSG(("+Cleaning up JS Cookie Filters"));
need_compile = JS_TRUE;
if (filter_context)
{
JS_BeginRequest(filter_context);
if (error_reporter_installed)
{
error_reporter_installed = JS_FALSE;
JS_SetErrorReporter(filter_context, previous_error_reporter);
}
JS_GC(filter_context);
destroyJSCookieFilterStuff();
JS_EndRequest(filter_context);
}
}

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,751 @@
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* The contents of this file are subject to the Netscape Public License
* Version 1.0 (the "NPL"); you may not use this file except in
* compliance with the NPL. You may obtain a copy of the NPL at
* http://www.mozilla.org/NPL/
*
* Software distributed under the NPL is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
* for the specific language governing rights and limitations under the
* NPL.
*
* The Initial Developer of this code under the NPL is Netscape
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
* Reserved.
*/
/* Please leave at the top for windows precompiled headers */
#include "mkutils.h"
#include <stddef.h>
#include <memory.h>
#include <time.h>
#include "net.h"
#include "xp.h"
#include "libmocha.h"
#include "mkgeturl.h"
#include "mkmocha.h"
#include "libevent.h"
#include "fe_proto.h"
#include "pa_tags.h" /* included via -I../libparse */
#include "libi18n.h" /* unicode */
#include "layout.h" /* for lo_ContextToCell only */
extern char lm_unknown_origin_str[];
extern int MK_OUT_OF_MEMORY;
extern int MK_MALFORMED_URL_ERROR;
typedef struct {
char * buffer;
size_t offset;
size_t length;
MWContext * context;
char * content_type;
int16 char_set;
} MochaStream;
typedef struct {
int32 ref_count;
ActiveEntry * active_entry;
PRPackedBool is_valid;
PRPackedBool eval_what;
PRPackedBool single_shot;
PRPackedBool polling;
char * str;
size_t len;
MWContext * context;
int status;
char * wysiwyg_url;
char * base_href;
NET_StreamClass * stream;
} MochaConData;
#define HOLD_CON_DATA(con_data) ((con_data)->ref_count++)
#define DROP_CON_DATA(con_data) { \
if (--(con_data)->ref_count == 0) \
free_con_data(con_data); \
}
static void
free_con_data(MochaConData * con_data)
{
XP_FREEIF(con_data->str);
XP_FREEIF(con_data->wysiwyg_url);
XP_FREEIF(con_data->base_href);
XP_FREE(con_data);
}
#define START_POLLING(ae, con_data) { \
(con_data)->polling = TRUE; \
NET_SetCallNetlibAllTheTime((ae)->window_id, "mkmocha"); \
}
#define STOP_POLLING(ae, con_data) { \
NET_ClearCallNetlibAllTheTime((ae)->window_id, "mkmocha"); \
(con_data)->polling = FALSE; \
}
/* forward decl */
PRIVATE int32 net_ProcessMocha(ActiveEntry * ae);
/*
* Add the new bits to our buffer
*/
PRIVATE int
mocha_process(NET_StreamClass *stream, const char *str, int32 len)
{
MochaStream * mocha_stream = (MochaStream *) stream->data_object;
mocha_stream->length += len;
if (!mocha_stream->buffer) {
mocha_stream->buffer = (char *)XP_ALLOC(mocha_stream->length);
}
else {
mocha_stream->buffer = (char *)XP_REALLOC(mocha_stream->buffer,
mocha_stream->length);
}
if (!mocha_stream->buffer) {
return MK_OUT_OF_MEMORY;
}
memcpy(mocha_stream->buffer + mocha_stream->offset, str, len);
mocha_stream->offset += len;
return len;
}
PRIVATE unsigned int
mocha_ready(NET_StreamClass *stream)
{
return MAX_WRITE_READY; /* always ready for writing */
}
/*
* All of the processing for this needs to be done in the mocha thread
*/
PRIVATE void
mocha_complete(NET_StreamClass *stream)
{
void * data;
JSBool isUnicode = JS_FALSE;
MochaStream * mocha_stream = (MochaStream *) stream->data_object;
if (mocha_stream->char_set != CS_DEFAULT) {
uint32 len;
INTL_Unicode * unicode;
/* find out how many unicode characters we'll end up with */
len = INTL_TextToUnicodeLen(mocha_stream->char_set,
(unsigned char *) mocha_stream->buffer,
mocha_stream->length);
unicode = XP_ALLOC(sizeof(INTL_Unicode) * len);
if (!unicode)
return;
/* do the conversion */
mocha_stream->length = INTL_TextToUnicode(mocha_stream->char_set,
(unsigned char *) mocha_stream->buffer,
mocha_stream->length,
unicode,
len);
data = unicode;
isUnicode = JS_TRUE;
XP_FREE(mocha_stream->buffer);
mocha_stream->buffer = NULL;
}
else {
data = mocha_stream->buffer;
}
/* this will grab ownership of data */
ET_MochaStreamComplete(mocha_stream->context, data,
mocha_stream->length,
mocha_stream->content_type,
isUnicode);
XP_FREEIF(mocha_stream->content_type);
XP_FREE(mocha_stream);
}
PRIVATE void
mocha_abort(NET_StreamClass *stream, int status)
{
MochaStream * mocha_stream = (MochaStream *) stream->data_object;
ET_MochaStreamAbort(mocha_stream->context, status);
XP_FREE(mocha_stream->buffer);
XP_FREEIF(mocha_stream->content_type);
XP_FREE(mocha_stream);
}
int16
net_check_for_charset(URL_Struct *url_struct)
{
int i, max;
char *key, *value;
static char charset[] = "charset=";
int len = XP_STRLEN(charset);
max = url_struct->all_headers.empty_index;
for (i = 0; i < max; i++) {
key = url_struct->all_headers.key[i];
/* keep looking until we find the content type one */
if (XP_STRCASECMP(key, "Content-type"))
continue;
value = url_struct->all_headers.value[i];
/* don't bother unless this is a JS file to begin with */
if (!strcasestr(value, APPLICATION_JAVASCRIPT))
return CS_DEFAULT;
value = XP_STRTOK(value, ";");
while (value) {
value = XP_StripLine(value);
if (!strncasecomp(value, charset, len)) {
value += len;
value = XP_StripLine(value);
return (INTL_CharSetNameToID(value));
}
/* move to next arg */
value = XP_STRTOK(NULL, ";");
}
/* found content-type but no charset */
return CS_DEFAULT;
}
/* didn't find content-type */
return CS_DEFAULT;
}
static char *
getOriginFromURLStruct(MWContext *context, URL_Struct *url_struct)
{
char *referer;
/*
* Look in url_struct->origin_url for this javascript: URL's
* original referrer.
*
* In the basis case, a javascript: or *.js URL targets a context
* from a (the same, or not) context loaded with a non-javascript URL.
* The referring document's URL is in url_struct->referer and we
* duplicate it as origin_url. If we find a non-null origin_url
* later, we know by induction where it came from.
*/
referer = url_struct->origin_url;
if (referer == NULL) {
/*
* url_struct->referer (sic) tells the URL of the page in
* which a javascript: or *.js link or form was clicked or submitted.
* If it's non-null, but the context is a frame cell that's
* being (re-)created for this load, don't use referer as the
* decoder's source URL for the evaluation, because the FE has
* arbitrarily set it to the top frameset's URL. Instead, use
* the immediate parent frameset context's wysiwyg URL to get
* the origin of the generator (or the parent's address URL if
* not wysiwyg).
*
* If referer is null, the user typed this javascript: URL or
* its frameset's URL directly into the Location toolbar.
*/
referer = url_struct->referer;
if (referer) {
lo_GridRec *grid = NULL;
if (context->is_grid_cell &&
!lo_ContextToCell(context, FALSE, &grid)) {
/*
* Context is a frame being (re)created: veto referer.
* The javascript: or *.js URL can't be a LAYER SRC= URL in a
* frame because the frame's cell must point to its
* context by the time the first tag (even LAYER) is
* processed by layout.
*/
referer = NULL;
}
}
if (!referer) {
History_entry *he;
if (context->grid_parent) {
/*
* If grid parent, use its history entry to get the
* wysiwyg or real URL, which tells the subject origin
* of (any code in it that may have generated) this
* javascript: or *.js URL open. If no grid parent, this must
* be a javascript: or *.js URL that was typed directly into
* Location.
*/
context = context->grid_parent;
}
he = SHIST_GetCurrent(&context->hist);
if (!he) {
referer = lm_unknown_origin_str;
} else {
referer = he->wysiwyg_url;
if (!referer)
referer = he->address;
}
}
}
XP_ASSERT(referer);
referer = XP_STRDUP(referer);
if (!referer) {
return NULL;
}
url_struct->origin_url = referer;
return referer;
}
NET_StreamClass *
NET_CreateMochaConverter(FO_Present_Types format_out,
void *data_object,
URL_Struct *url_struct,
MWContext *context)
{
MochaStream * mocha_stream;
NET_StreamClass *stream;
char *origin;
mocha_stream = (MochaStream *) XP_NEW_ZAP(MochaStream);
if (!mocha_stream)
return NULL;
mocha_stream->context = context;
mocha_stream->content_type = XP_STRDUP(url_struct->content_type);
mocha_stream->char_set = net_check_for_charset(url_struct);
/* Get the origin from the URL struct. We don't have to free origin
* here because url_struct->origin_url owns it.
*/
origin = getOriginFromURLStruct(context, url_struct);
if (origin == NULL)
return NULL;
if (NET_URL_Type(url_struct->address) == FILE_TYPE_URL &&
NET_URL_Type(origin) != FILE_TYPE_URL)
{
/*
* Don't allow loading a file: URL from a non-file URL to
* prevent privacy attacks against the local machine from
* web pages.
*/
return NULL;
}
stream = NET_NewStream("mocha", mocha_process, mocha_complete,
mocha_abort, mocha_ready, mocha_stream,
context);
return stream;
}
PRIVATE void
mk_mocha_eval_exit_fn(void * data, char * str, size_t len, char * wysiwyg_url,
char * base_href, Bool valid)
{
MochaConData * con_data = (MochaConData *) data;
if (!valid) {
con_data->status = MK_MALFORMED_URL_ERROR;
con_data->is_valid = TRUE;
return;
}
if (str == NULL) {
con_data->status = MK_DATA_LOADED;
con_data->is_valid = TRUE;
return;
}
con_data->base_href = base_href;
con_data->wysiwyg_url = wysiwyg_url;
con_data->str = str;
con_data->len = len;
con_data->is_valid = TRUE;
}
/*
* Handle both 'mocha:<stuff>' urls and the mocha type-in widget
*/
MODULE_PRIVATE int32
net_MochaLoad(ActiveEntry *ae)
{
MWContext *context;
URL_Struct *url_struct;
char *what;
Bool eval_what, single_shot;
MochaConData * con_data;
context = ae->window_id;
url_struct = ae->URL_s;
what = XP_STRCHR(url_struct->address, ':');
XP_ASSERT(what);
what++;
eval_what = FALSE;
single_shot = (*what != '?');
if (single_shot) {
/* Don't use an existing Mocha output window's stream. */
if (*what == '\0') {
/* Generate two grid cells, one for output and one for input. */
what = PR_smprintf("<frameset rows=\"75%%,25%%\">\n"
"<frame name=MochaOutput src=about:blank>\n"
"<frame name=MochaInput src=%.*s#input>\n"
"</frameset>",
what - url_struct->address,
url_struct->address);
} else if (!XP_STRCMP(what, "#input")) {
/* The input cell contains a form with one magic isindex field. */
what = PR_smprintf("<b>%.*s typein</b>\n"
"<form action=%.*s target=MochaOutput"
" onsubmit='this.isindex.focus()'>\n"
"<input name=isindex size=60>\n"
"</form>",
what - url_struct->address - 1,
url_struct->address,
what - url_struct->address,
url_struct->address);
url_struct->internal_url = TRUE;
} else {
eval_what = TRUE;
}
} else {
/* Use the Mocha output window if it exists. */
url_struct->auto_scroll = 1000;
/* Skip the leading question-mark and clean up the string. */
what++;
NET_PlusToSpace(what);
NET_UnEscape(what);
eval_what = TRUE;
}
/* something got hosed. bail */
if (!what) {
ae->status = MK_OUT_OF_MEMORY;
return -1;
}
/* make space for the connection data */
con_data = XP_NEW_ZAP(MochaConData);
if (!con_data) {
ae->status = MK_OUT_OF_MEMORY;
return -1;
}
/* remember for next time */
con_data->ref_count = 1;
con_data->active_entry = ae;
ae->con_data = con_data;
/* set up some state so we remember where we are */
con_data->eval_what = eval_what;
con_data->single_shot = single_shot;
con_data->context = context;
/* fake out netlib so we don't select on the socket id */
ae->socket = NULL;
ae->local_file = TRUE;
if (eval_what) {
char *referer;
JSPrincipals *principals;
ETEvalStuff *stuff;
referer = getOriginFromURLStruct(context, url_struct);
if (!referer) {
ae->status = MK_OUT_OF_MEMORY;
return -1;
}
principals = LM_NewJSPrincipals(NULL, NULL, referer);
if (!principals) {
ae->status = MK_OUT_OF_MEMORY;
return -1;
}
/*
* send the buffer off to be evaluated
*/
stuff = (ETEvalStuff *) XP_NEW_ZAP(ETEvalStuff);
if (!stuff) {
ae->status = MK_OUT_OF_MEMORY;
return -1;
}
stuff->len = XP_STRLEN(what);
stuff->line_no = 0;
stuff->scope_to = NULL;
stuff->want_result = JS_TRUE;
stuff->data = con_data;
stuff->version = JSVERSION_UNKNOWN;
stuff->principals = principals;
ET_EvaluateScript(context, what, stuff, mk_mocha_eval_exit_fn);
}
else {
/* allocated above, don't need to free */
con_data->str = what;
con_data->len = XP_STRLEN(what);
con_data->is_valid = TRUE;
}
/* make sure netlib gets called so we know when our data gets back */
START_POLLING(ae, con_data);
/* ya'll come back now, ya'hear? */
return net_ProcessMocha(ae);
}
PRIVATE int
net_process_mocha(MochaConData * con_data)
{
int32 ref_count;
ref_count = con_data->ref_count;
DROP_CON_DATA(con_data);
if (ref_count == 1 || !con_data->active_entry)
return -1;
return net_ProcessMocha(con_data->active_entry);
}
static char nscp_open_tag[] = "<" PT_NSCP_OPEN ">";
/*
* If the mocha has finished evaluation shove the result
* down the stream and continue else just wait
*/
PRIVATE int32
net_ProcessMocha(ActiveEntry * ae)
{
FO_Present_Types output_format;
Bool to_layout;
Bool first_time;
NET_StreamClass *stream = NULL;
MochaConData * con_data = (MochaConData *) ae->con_data;
MWContext * context;
int status;
/* if we haven't gotten our data yet just return and wait */
if (!con_data || !con_data->is_valid)
return 0;
context = ae->window_id;
/*
* Race with the mocha thread until we can grab the JSLock
*/
if (!con_data->single_shot) {
MochaDecoder * decoder;
HOLD_CON_DATA(con_data);
if (!LM_AttemptLockJS(context,
(JSLockReleaseFunc)net_process_mocha, con_data))
return 0;
DROP_CON_DATA(con_data);
decoder = LM_GetMochaDecoder(context);
if (!decoder) {
LM_UnlockJS(context);
ae->status = MK_OUT_OF_MEMORY;
goto done;
}
stream = decoder->stream;
LM_PutMochaDecoder(decoder);
LM_UnlockJS(context);
}
else {
stream = con_data->stream;
}
/* we've gotten valid data, clear the callme all the time flag */
STOP_POLLING(ae, con_data);
/* see if there were any problems */
if (con_data->status < 0 || con_data->str == NULL) {
ET_SendLoadEvent(context, EVENT_LOAD, NULL, NULL,
LO_DOCUMENT_LAYER_ID, FALSE);
ae->status = con_data->status;
goto done;
}
/*
* If we don't already have a stream to take our output create one now
*/
first_time = !stream;
if (first_time) {
StrAllocCopy(ae->URL_s->content_type, TEXT_HTML);
ae->format_out = CLEAR_CACHE_BIT(ae->format_out);
stream = NET_StreamBuilder(ae->format_out, ae->URL_s, ae->window_id);
if (!stream) {
ae->status = MK_UNABLE_TO_CONVERT;
goto done;
}
}
/*
* If the stream we just created isn't ready for writing just
* hold onto the stream and try again later
*/
if (!stream->is_write_ready(stream)) {
con_data->stream = stream;
START_POLLING(ae, con_data);
return 0;
}
/* XXX this condition is fairly bogus */
output_format = CLEAR_CACHE_BIT(ae->format_out);
to_layout = (output_format != FO_INTERNAL_IMAGE &&
output_format != FO_MULTIPART_IMAGE &&
output_format != FO_EMBED &&
output_format != FO_PLUGIN);
if (to_layout) {
/* The string must end in a newline so the parser will flush it. */
if (con_data->len != 0 && con_data->str[con_data->len-1] != '\n') {
size_t new_len = con_data->len + 1;
char * new_str = XP_ALLOC((new_len + 1) * sizeof(char));
if (!new_str) {
ae->status = MK_OUT_OF_MEMORY;
goto done;
}
XP_MEMCPY(new_str, con_data->str, con_data->len);
new_str[new_len-1] = '\n';
new_str[new_len] = '\0';
con_data->str = new_str;
con_data->len = new_len;
}
}
/*
* If this is the first time do some initial setup. We'll set
* the window title and maybe shove out a <BASE> tag
*/
status = 0;
if (to_layout && first_time && con_data->eval_what) {
/* Feed layout an internal tag so it will create a new top state. */
stream->put_block(stream, nscp_open_tag,
sizeof nscp_open_tag - 1);
(void) LM_WysiwygCacheConverter(context, ae->URL_s,
con_data->wysiwyg_url,
con_data->base_href);
if (*con_data->str != '<') {
char * prefix = NULL;
StrAllocCopy(prefix, "<TITLE>");
StrAllocCat(prefix, ae->URL_s->address);
StrAllocCat(prefix, "</TITLE><PLAINTEXT>");
if (!prefix) {
ae->status = MK_OUT_OF_MEMORY;
goto done;
}
status = (*stream->put_block)(stream, prefix,
XP_STRLEN(prefix));
XP_FREE(prefix);
}
else {
if (con_data->base_href) {
status = (*stream->put_block)(stream,
con_data->base_href,
XP_STRLEN(con_data->base_href));
}
}
}
if (status >= 0) {
status = (*stream->put_block)(stream, con_data->str,
(int32)con_data->len);
}
if (con_data->single_shot && status >= 0)
(*stream->complete)(stream);
if (!con_data->single_shot && status >= 0) {
if (first_time) {
ET_SetDecoderStream(context, stream, ae->URL_s, JS_TRUE);
goto done;
}
} else {
if (status < 0)
(*stream->abort)(stream, status);
if (first_time)
XP_DELETE(stream);
}
ae->status = MK_DATA_LOADED;
done:
ae->con_data = NULL;
con_data->active_entry = NULL;
DROP_CON_DATA(con_data);
return -1;
}
PRIVATE int32
net_InterruptMocha(ActiveEntry *ae)
{
MochaConData * con_data = (MochaConData *) ae->con_data;
if (!con_data)
return MK_INTERRUPTED;
/* do we need to decrement the callme all the time flag? */
if (con_data->polling) {
STOP_POLLING(ae, con_data);
}
/* ae is about to go away, break its connection with con_data */
ae->con_data = NULL;
con_data->active_entry = NULL;
/* ae is about to go away, better get it off the JS lock waiters list */
if (LM_ClearAttemptLockJS(con_data->context,
(JSLockReleaseFunc)net_process_mocha, con_data))
DROP_CON_DATA(con_data);
return ae->status = MK_INTERRUPTED;
}
PRIVATE void
net_CleanupMocha(void)
{
/* nothing so far needs freeing */
return;
}
MODULE_PRIVATE void
NET_InitMochaProtocol(void)
{
static NET_ProtoImpl mocha_proto_impl;
mocha_proto_impl.init = net_MochaLoad;
mocha_proto_impl.process = net_ProcessMocha;
mocha_proto_impl.interrupt = net_InterruptMocha;
mocha_proto_impl.cleanup = net_CleanupMocha;
NET_RegisterProtocolImplementation(&mocha_proto_impl, MOCHA_TYPE_URL);
}

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,187 @@
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* The contents of this file are subject to the Netscape Public License
* Version 1.0 (the "NPL"); you may not use this file except in
* compliance with the NPL. You may obtain a copy of the NPL at
* http://www.mozilla.org/NPL/
*
* Software distributed under the NPL is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
* for the specific language governing rights and limitations under the
* NPL.
*
* The Initial Developer of this code under the NPL is Netscape
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
* Reserved.
*/
#include "xp_core.h"
#include "xp_mcom.h"
#include "jsapi.h"
#include "prefapi.h"
#include "hk_funcs.h"
#include "hk_private.h"
static JSObject *HookObject = NULL;
JSObject *
hk_GetHookObject(void)
{
return HookObject;
}
void
hk_SetHookObject(JSObject *hook_obj)
{
HookObject = hook_obj;
}
/*
* Some hooks have dynamic names and can't be in the
* fast hook array lookup, this covers looking up those
* hooks. For example, if I invented a <BLURT> tag,
* this would look for a BLURT_hook function.
*/
intn
hk_IsUnknownTagHook(void *extra)
{
const char *hook_func;
jsval tmp_val;
JSContext *j_context;
hook_func = HK_GetFunctionName(HK_TAG, extra);
if (hook_func == NULL)
{
return 0;
}
if (!PREF_GetConfigContext(&j_context))
{
return 0;
}
if ((j_context == NULL)||(HookObject == NULL))
{
return 0;
}
JS_BeginRequest(j_context);
if ((JS_GetProperty(j_context, HookObject, hook_func, &tmp_val))&&
(JS_TypeOfValue(j_context, tmp_val) == JSTYPE_FUNCTION))
{
JS_EndRequest(j_context);
return 1;
}
JS_EndRequest(j_context);
return 0;
}
/*
* There is no guarantee that someone has checked the existence of the
* hook before calling it, so we check again here. We don't use the
* fast array lookup since it can't catch all hooks anyway, and we
* may well have to fall back to the slow method.
*/
intn
HK_CallHook(int32 hook_id, void *extra, int32 window_id,
char *hook_str, char **hook_ret)
{
const char *hook_func;
intn ok;
jsval tmp_val;
jsval argv[2];
JSContext *j_context;
JSString *str;
const char *result_str;
char *return_str;
*hook_ret = NULL;
if (hook_str == NULL)
{
return 0;
}
/*
* Make a function name form the hook_is and possibly the PA_Tag
* pointed to by extra.
*/
hook_func = HK_GetFunctionName(hook_id, extra);
if (hook_func == NULL)
{
return 0;
}
/*
* Make sure you have a javascript context and object.
*/
if (!PREF_GetConfigContext(&j_context))
{
return 0;
}
if ((j_context == NULL)||(HookObject == NULL))
{
return 0;
}
JS_BeginRequest(j_context);
/*
* Check that there is a function to call.
*/
if ((!JS_GetProperty(j_context, HookObject, hook_func, &tmp_val))||
(JS_TypeOfValue(j_context, tmp_val) != JSTYPE_FUNCTION))
{
JS_EndRequest(j_context);
return 0;
}
/*
* Create the argument/parameter list, and call the function.
*/
str = JS_NewStringCopyZ(j_context, hook_str);
if (str == NULL)
{
JS_EndRequest(j_context);
return 0;
}
argv[0] = STRING_TO_JSVAL(str);
argv[1] = INT_TO_JSVAL(window_id);
if (!JS_CallFunctionName(j_context, HookObject, hook_func, 2, argv,
&tmp_val))
{
JS_EndRequest(j_context);
return 0;
}
/*
* A false return from the function means leave the
* passed string unchanged.
*/
if (tmp_val != JSVAL_FALSE)
{
str = JS_ValueToString(j_context, tmp_val);
if (str == NULL)
{
JS_EndRequest(j_context);
return 0;
}
result_str = JS_GetStringBytes(str);
return_str = XP_STRDUP(result_str);
if (return_str == NULL)
{
JS_EndRequest(j_context);
return 0;
}
*hook_ret = return_str;
}
JS_EndRequest(j_context);
return 1;
}

View File

@@ -0,0 +1,414 @@
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* The contents of this file are subject to the Netscape Public License
* Version 1.0 (the "NPL"); you may not use this file except in
* compliance with the NPL. You may obtain a copy of the NPL at
* http://www.mozilla.org/NPL/
*
* Software distributed under the NPL is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
* for the specific language governing rights and limitations under the
* NPL.
*
* The Initial Developer of this code under the NPL is Netscape
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
* Reserved.
*/
#include "xp_core.h"
#include "xp_mcom.h"
#include "hk_types.h"
#include "jsapi.h"
#include "prefapi.h"
#include "ntypes.h"
#include "structs.h"
#include "pa_tags.h"
#include "hk_private.h"
#ifdef XP_MAC
#include "hk_funcs.h"
#endif
static hk_FunctionRec **FunctionList = NULL;
static int32 FunctionCount = 0;
static char *hk_FunctionStrings[HK_MAX] = {
NULL,
"location_hook",
"_hook",
"document_start_hook"};
static JSClass autoconf_class = {
"HookConfig", 0,
hk_HookObjectAddProperty, hk_HookObjectDeleteProperty,
JS_PropertyStub, hk_HookObjectSetProperty,
JS_EnumerateStub, JS_ResolveStub, JS_ConvertStub, JS_FinalizeStub
};
/*******************************************
* This function really bugs me! It needs to
* be super fast since it will be called for every
* HTML tag ever processed. This means it should be
* self-contained, and not call off to other functions.
* Making it do that means it can't call off into
* hk_tag.c to get inside the PA_Tag structure in extra,
* and thus makes me include ntypes.h, structs.h, and pa_tags.h.
********************************************/
/*
* A FAST function existence lookup, using an array set up in
* the initialization process.
*/
intn
HK_IsHook(int32 hook_id, void *extra)
{
int32 func_id;
hk_FunctionRec *rec_ptr;
/*
* The no hook case never exists.
*/
if (hook_id == HK_NONE)
{
return 0;
}
/*
* Tag hooks map to the tag types, or alternatly
* unknown tags which are handled elsewhere.
*/
else if (hook_id == HK_TAG)
{
PA_Tag *tag;
tag = (PA_Tag *)extra;
if (tag->type != P_UNKNOWN)
{
func_id = HK_MAX - 1 + tag->type;
}
/*
* P_UNKNOWN tags must be looked up the slow
* dynamic way.
*/
else
{
return(hk_IsUnknownTagHook(extra));
}
}
else
{
func_id = hook_id - 1;
}
/*
* If we are outside the known funtion array, fail.
*/
if ((func_id < 0)||(func_id >= FunctionCount))
{
return 0;
}
/*
* If no function is registered, fail.
*/
rec_ptr = FunctionList[func_id];
if (rec_ptr == NULL)
{
return 0;
}
if (rec_ptr->func_exists == FALSE)
{
return 0;
}
else
{
return 1;
}
}
/*
* Set the existence state of a particular index in the array.
*/
static void
hk_set_function_existence(int32 indx, XP_Bool exists)
{
if ((indx < 0)||(indx >= FunctionCount))
{
return;
}
if (FunctionList[indx] != NULL)
{
FunctionList[indx]->func_exists = exists;
}
}
void
hk_SetFunctionExistence(char *func_name, XP_Bool exists)
{
int32 i, len;
char *tptr;
char *up_str;
char *ptr1, *ptr2;
int32 indx;
/*
* A NULL function one too short for the hook suffix
* cannot be a hook function.
*/
if (func_name == NULL)
{
return;
}
len = XP_STRLEN(func_name);
if (len < XP_STRLEN("_hook"))
{
return;
}
/*
* If the function has no hook suffix we just don't care.
*/
tptr = func_name + len - XP_STRLEN("_hook");
if (XP_STRCMP(tptr, "_hook") != 0)
{
return;
}
/*
* Make an all upper-case copy of the prefix.
*/
*tptr = '\0';
up_str = XP_ALLOC(XP_STRLEN(func_name) + 1);
/*
* If allocation fails, restore original and return.
*/
if (up_str == NULL)
{
*tptr = '_';
return;
}
ptr1 = func_name;
ptr2 = up_str;
while (*ptr1 != '\0')
{
*ptr2 = (char)(XP_TO_UPPER(*ptr1));
ptr1++;
ptr2++;
}
*ptr2 = '\0';
*tptr = '_';
/*
* Check if the prefix is a known TAG name.
*/
indx = hk_TagStringToIndex(up_str);
XP_FREE(up_str);
if (indx >= 0)
{
indx = HK_MAX - 1 + indx;
hk_set_function_existence(indx, exists);
return;
}
/*
* Special check for the TEXT_hook which is a tag hook but
* won't be caught by the hk_TagStringToIndex test.
*/
if (XP_STRCMP(func_name, "TEXT_hook") == 0)
{
indx = HK_MAX - 1 + 0;
hk_set_function_existence(indx, exists);
return;
}
/*
* Finally, check the array of known tag hooks.
*/
for (i=1; i<HK_MAX; i++)
{
if ((hk_FunctionStrings[i] != NULL)&&
(XP_STRCMP(func_name, hk_FunctionStrings[i]) == 0))
{
indx = i - 1;
hk_set_function_existence(indx, exists);
return;
}
}
}
/*
* Free all members of the function list array up to
* the passed index.
*/
static void
hk_free_function_list(int32 indx)
{
int32 i;
for (i=0; i<indx; i++)
{
if (FunctionList[i] != NULL)
{
if (FunctionList[i]->func_name != NULL)
{
XP_FREE(FunctionList[i]->func_name);
FunctionList[i]->func_name = NULL;
}
XP_FREE(FunctionList[i]);
FunctionList[i] = NULL;
}
}
XP_FREE(FunctionList);
FunctionList = NULL;
FunctionCount = 0;
}
/*
* Initialize the function list array to contain all the known tags
* plus all the known special hook functions.
*/
static intn
hk_initialize_function_list(void)
{
int32 i, indx;
int32 tag_cnt;
/*
* Subtract one from HK_MAX because it includes the unknown
* at 0. For the tag count, unknown is -1, so we can just
* use it as is.
*/
tag_cnt = hk_NumKnownTags();
FunctionCount = HK_MAX - 1 + tag_cnt;
FunctionList = (hk_FunctionRec **)XP_ALLOC(FunctionCount *
sizeof(hk_FunctionRec *));
if (FunctionList == NULL)
{
return 0;
}
indx = 0;
/*
* First allocate all the known special hooks.
*/
for (i=1; i < HK_MAX; i++)
{
hk_FunctionRec *rec_ptr;
rec_ptr = XP_NEW(hk_FunctionRec);
if (rec_ptr == NULL)
{
hk_free_function_list(indx);
return 0;
}
rec_ptr->func_exists = FALSE;
rec_ptr->func_name = hk_FunctionStrings[i];
FunctionList[indx] = rec_ptr;
indx++;
}
/*
* Now do all known tags.
*/
for (i=0; i < tag_cnt; i++)
{
hk_FunctionRec *rec_ptr;
rec_ptr = XP_NEW(hk_FunctionRec);
if (rec_ptr == NULL)
{
hk_free_function_list(indx);
return 0;
}
rec_ptr->func_exists = FALSE;
rec_ptr->func_name = hk_TagIndexToFunctionString(i);
FunctionList[indx] = rec_ptr;
indx++;
}
return 1;
}
/*
* Initialize all the libhook stuff. SHould only be called once.
* Usually just before reading hook.js.
*/
intn
HK_Init(void)
{
intn ret;
JSContext *j_context;
JSObject *j_object;
JSObject *hook_obj;
/*
* If a hook object does not already exist, create
* one. If you cannot create one, then return failure.
*/
hook_obj = hk_GetHookObject();
if (hook_obj == NULL)
{
if ((!PREF_GetConfigContext(&j_context))||
(!PREF_GetGlobalConfigObject(&j_object)))
{
return 0;
}
JS_BeginRequest(j_context);
hook_obj = JS_DefineObject(j_context, j_object,
"HookConfig",
&autoconf_class,
NULL,
JSPROP_ENUMERATE|JSPROP_READONLY|JSPROP_PERMANENT);
JS_EndRequest(j_context);
}
if (hook_obj == NULL)
{
return 0;
}
hk_SetHookObject(hook_obj);
ret = hk_initialize_function_list();
return ret;
}
/*
* Get the hook know for the passed hook id.
*/
const char *
HK_GetFunctionName(int32 hook_id, void *extra)
{
if ((hook_id < 0)||(hook_id >= HK_MAX))
{
return NULL;
}
/*
* Special name creation for tag hooks.
*/
if (hook_id == HK_TAG)
{
const char *ret_str;
ret_str = (const char *)hk_TagFunctionString(
hk_FunctionStrings[hook_id], extra);
return ret_str;
}
else
{
return hk_FunctionStrings[hook_id];
}
}

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -1,5 +0,0 @@
<IfModule mod_rewrite.c>
RewriteEngine on
RewriteRule ^$ webroot/ [L]
RewriteRule (.*) webroot/$1 [L]
</IfModule>

View File

@@ -1,69 +0,0 @@
<?php
/* SVN FILE: $Id: app_controller.php,v 1.1.1.1 2006-05-24 19:14:24 uid815 Exp $ */
/**
* Short description for file.
*
* This file is application-wide controller file. You can put all
* application-wide controller-related methods here.
*
* PHP versions 4 and 5
*
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
* Copyright (c) 2006, Cake Software Foundation, Inc.
* 1785 E. Sahara Avenue, Suite 490-204
* Las Vegas, Nevada 89104
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @filesource
* @copyright Copyright (c) 2006, Cake Software Foundation, Inc.
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
* @package cake
* @subpackage cake.cake
* @since CakePHP v 0.2.9
* @version $Revision: 1.1.1.1 $
* @modifiedby $LastChangedBy: phpnut $
* @lastmodified $Date: 2006-05-24 19:14:24 $
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
*/
/**
* Short description for class.
*
* Add your application-wide methods in the class below, your controllers
* will inherit them.
*
* @package cake
* @subpackage cake.cake
*/
uses('Sanitize');
class AppController extends Controller {
/**
* This function is intended to be used with url parameters when passing them to
* a view. (This is useful when echoing values out in <input> tags, etc.
* Note that the keys to the arrays are escaped as well.
*
* @param array dirty parameters
* @return array cleaned values
*/
function decodeAndSanitize($params)
{
$clean = array();
foreach ($params as $var => $val) {
$var = $this->Sanitize->html(urldecode($var));
$val = $this->Sanitize->html(urldecode($val));
$clean[$var] = $val;
}
return $clean;
}
}
?>

View File

@@ -1,72 +0,0 @@
<?php
/* SVN FILE: $Id: app_model.php,v 1.1.1.1 2006-05-24 19:14:24 uid815 Exp $ */
/**
* Application model for Cake.
*
* This file is application-wide model file. You can put all
* application-wide model-related methods here.
*
* PHP versions 4 and 5
*
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
* Copyright (c) 2006, Cake Software Foundation, Inc.
* 1785 E. Sahara Avenue, Suite 490-204
* Las Vegas, Nevada 89104
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @filesource
* @copyright Copyright (c) 2006, Cake Software Foundation, Inc.
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
* @package cake
* @subpackage cake.cake
* @since CakePHP v 0.2.9
* @version $Revision: 1.1.1.1 $
* @modifiedby $LastChangedBy: phpnut $
* @lastmodified $Date: 2006-05-24 19:14:24 $
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
*/
/**
* Application model for Cake.
*
* Add your application-wide methods in the class below, your models
* will inherit them.
*
* @package cake
* @subpackage cake.cake
*/
uses('sanitize');
class AppModel extends Model {
/**
* Will clean arrays for input into SQL.
* Note that the array keys are getting cleaned here as well. If you're using strings
* (with escapable characters in them) as keys to your array, be extra careful.
*
* @access public
* @param array to be cleaned
* @return array with sql escaped
*/
function cleanArrayForSql($array)
{
$sanitize = new Sanitize();
$clean = array();
foreach ($array as $var => $val)
{
$var = $sanitize->sql($var);
$val = $sanitize->sql($val);
$clean[$var] = $val;
}
return $clean;
}
}
?>

View File

@@ -1,76 +0,0 @@
;<?php die() ?>
; SVN FILE: $Id: acl.ini.php,v 1.1.1.1 2006-05-24 19:14:24 uid815 Exp $
;/**
; * Short description for file.
; *
; *
; * PHP versions 4 and 5
; *
; * CakePHP : Rapid Development Framework <http://www.cakephp.org/>
; * Copyright (c) 2006, Cake Software Foundation, Inc.
; * 1785 E. Sahara Avenue, Suite 490-204
; * Las Vegas, Nevada 89104
; *
; * Licensed under The MIT License
; * Redistributions of files must retain the above copyright notice.
; *
; * @filesource
; * @copyright Copyright (c) 2006, Cake Software Foundation, Inc.
; * @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
; * @package cake
; * @subpackage cake.app.config
; * @since CakePHP v 0.10.0.1076
; * @version $Revision: 1.1.1.1 $
; * @modifiedby $LastChangedBy: phpnut $
; * @lastmodified $Date: 2006-05-24 19:14:24 $
; * @license http://www.opensource.org/licenses/mit-license.php The MIT License
; */
; acl.ini.php - Cake ACL Configuration
; ---------------------------------------------------------------------
; Use this file to specify user permissions.
; aco = access control object (something in your application)
; aro = access request object (something requesting access)
;
; User records are added as follows:
;
; [uid]
; groups = group1, group2, group3
; allow = aco1, aco2, aco3
; deny = aco4, aco5, aco6
;
; Group records are added in a similar manner:
;
; [gid]
; allow = aco1, aco2, aco3
; deny = aco4, aco5, aco6
;
; The allow, deny, and groups sections are all optional.
; NOTE: groups names *cannot* ever be the same as usernames!
;
; ACL permissions are checked in the following order:
; 1. Check for user denies (and DENY if specified)
; 2. Check for user allows (and ALLOW if specified)
; 3. Gather user's groups
; 4. Check group denies (and DENY if specified)
; 5. Check group allows (and ALLOW if specified)
; 6. If no aro, aco, or group information is found, DENY
;
; ---------------------------------------------------------------------
;-------------------------------------
;Users
;-------------------------------------
[username-goes-here]
groups = group1, group2
deny = aco1, aco2
allow = aco3, aco4
;-------------------------------------
;Groups
;-------------------------------------
[groupname-goes-here]
deny = aco5, aco6
allow = aco7, aco8

View File

@@ -1,50 +0,0 @@
<?php
/* SVN FILE: $Id: bootstrap.php,v 1.1.1.1 2006-05-24 19:14:24 uid815 Exp $ */
/**
* Short description for file.
*
* Long description for file
*
* PHP versions 4 and 5
*
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
* Copyright (c) 2006, Cake Software Foundation, Inc.
* 1785 E. Sahara Avenue, Suite 490-204
* Las Vegas, Nevada 89104
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @filesource
* @copyright Copyright (c) 2006, Cake Software Foundation, Inc.
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
* @package cake
* @subpackage cake.app.config
* @since CakePHP v 0.10.8.2117
* @version $Revision: 1.1.1.1 $
* @modifiedby $LastChangedBy: phpnut $
* @lastmodified $Date: 2006-05-24 19:14:24 $
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
*/
/**
*
* This file is loaded automatically by the app/webroot/index.php file after the core bootstrap.php is loaded
* This is an application wide file to load any function that is not used within a class define.
* You can also use this to include or require any files in your application.
*
*/
/**
* The settings below can be used to set additional paths to models, views and controllers.
* This is related to Ticket #470 (https://trac.cakephp.org/ticket/470)
*
* $modelPaths = array('full path to models', 'second full path to models', 'etc...');
* $viewPaths = array('this path to views', 'second full path to views', 'etc...');
* $controllerPaths = array('this path to controllers', 'second full path to controllers', 'etc...');
*
*/
//EOF
?>

View File

@@ -1,153 +0,0 @@
<?php
/* SVN FILE: $Id: core.php,v 1.1.1.1 2006-05-24 19:14:24 uid815 Exp $ */
/**
* This is core configuration file.
*
* Use it to configure core behaviour ofCake.
*
* PHP versions 4 and 5
*
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
* Copyright (c) 2006, Cake Software Foundation, Inc.
* 1785 E. Sahara Avenue, Suite 490-204
* Las Vegas, Nevada 89104
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @filesource
* @copyright Copyright (c) 2006, Cake Software Foundation, Inc.
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
* @package cake
* @subpackage cake.app.config
* @since CakePHP v 0.2.9
* @version $Revision: 1.1.1.1 $
* @modifiedby $LastChangedBy: phpnut $
* @lastmodified $Date: 2006-05-24 19:14:24 $
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
*/
/**
* If you do not have mod rewrite on your system
* or if you prefer to use CakePHP pretty urls.
* uncomment the line below.
* Note: If you do have mod rewrite but prefer the
* CakePHP pretty urls, you also have to remove the
* .htaccess files
* release/.htaccess
* release/app/.htaccess
* release/app/webroot/.htaccess
*/
//define ('BASE_URL', env('SCRIPT_NAME'));
/**
* Set debug level here:
* - 0: production
* - 1: development
* - 2: full debug with sql
* - 3: full debug with sql and dump of the current object
*
* In production, the "flash messages" redirect after a time interval.
* With the other debug levels you get to click the "flash message" to continue.
*
*/
define('DEBUG', 0);
/**
* Turn of caching checking wide.
* You must still use the controller var cacheAction inside you controller class.
* You can either set it controller wide, or in each controller method.
* use var $cacheAction = true; or in the controller method $this->cacheAction = true;
*/
define ('CACHE_CHECK', false);
/**
* Error constant. Used for differentiating error logging and debugging.
* Currently PHP supports LOG_DEBUG
*/
define ('LOG_ERROR', 2);
/**
* CakePHP includes 3 types of session saves
* database or file. Set this to your preferred method.
* If you want to use your own save handler place it in
* app/config/name.php DO NOT USE file or database as the name.
* and use just the name portion below.
*
* Setting this to cake will save files to /cakedistro/tmp directory
* Setting it to php will use the php default save path
* Setting it to database will use the database
*
*
*/
define('CAKE_SESSION_SAVE', 'php');
/**
* Set a random string of used in session.
*
*/
define('CAKE_SESSION_STRING', 'DYhG93b0qyJfIxfs2guVoUubWwvniR2G0FgaC9mi');
/**
* Set the name of session cookie
*
*/
define('CAKE_SESSION_COOKIE', 'CAKEPHP');
/**
* Set level of Cake security.
*
*/
define('CAKE_SECURITY', 'high');
/**
* Set Cake Session time out.
* If CAKE_SECURITY define is set
* high: multiplied by 10
* medium: is multiplied by 100
* low is: multiplied by 300
*
* Number below is seconds.
*/
define('CAKE_SESSION_TIMEOUT', '120');
/**
* Uncomment the define below to use cake built in admin routes.
* You can set this value to anything you want.
* All methods related to the admin route should be prefixed with the
* name you set CAKE_ADMIN to.
* For example: admin_index, admin_edit
*/
//define('CAKE_ADMIN', 'admin');
/**
* The define below is used to turn cake built webservices
* on or off. Default setting is off.
*/
define('WEBSERVICES', 'off');
/**
* Compress output CSS (removing comments, whitespace, repeating tags etc.)
* This requires a/var/cache directory to be writable by the web server (caching).
* To use, prefix the CSS link URL with '/ccss/' instead of '/css/' or use Controller::cssTag().
*/
define('COMPRESS_CSS', false);
/**
* If set to true, helpers would output data instead of returning it.
*/
define('AUTO_OUTPUT', false);
/**
* If set to false, session would not automatically be started.
*/
define('AUTO_SESSION', true);
/**
* Set the max size of file to use md5() .
*/
define('MAX_MD5SIZE', (5*1024)*1024 );
/**
* To use Access Control Lists with Cake...
*/
define('ACL_CLASSNAME', 'DB_ACL');
define('ACL_FILENAME', 'dbacl'.DS.'db_acl');
?>

View File

@@ -1,79 +0,0 @@
<?php
/* SVN FILE: $Id: database.php.default,v 1.1.1.1 2006-05-24 19:14:24 uid815 Exp $ */
/**
* This is core configuration file.
*
* Use it to configure core behaviour ofCake.
*
* PHP versions 4 and 5
*
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
* Copyright (c) 2006, Cake Software Foundation, Inc.
* 1785 E. Sahara Avenue, Suite 490-204
* Las Vegas, Nevada 89104
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @filesource
* @copyright Copyright (c) 2006, Cake Software Foundation, Inc.
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
* @package cake
* @subpackage cake.app.config
* @since CakePHP v 0.2.9
* @version $Revision: 1.1.1.1 $
* @modifiedby $LastChangedBy: phpnut $
* @lastmodified $Date: 2006-05-24 19:14:24 $
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
*/
/**
* In this file you set up your database connection details.
*
* @package cake
* @subpackage cake.config
*/
/**
* Database configuration class.
* You can specify multiple configurations for production, development and testing.
*
* driver =>
* mysql, postgres, sqlite, adodb-drivername, pear-drivername
*
* connect =>
* MySQL set the connect to either mysql_pconnect of mysql_connect
* PostgreSQL set the connect to either pg_pconnect of pg_connect
* SQLite set the connect to sqlite_popen sqlite_open
* ADOdb set the connect to one of these
* (http://phplens.com/adodb/supported.databases.html) and
* append it '|p' for persistent connection. (mssql|p for example, or just mssql for not persistent)
*
* host =>
* the host you connect to the database
* MySQL 'localhost' to add a port number use 'localhost:port#'
* PostgreSQL 'localhost' to add a port number use 'localhost port=5432'
*
*/
class DATABASE_CONFIG
{
var $default = array('driver' => 'mysql',
'connect' => 'mysql_connect',
'host' => 'localhost',
'login' => 'user',
'password' => 'password',
'database' => 'project_name',
'prefix' => '');
var $test = array('driver' => 'mysql',
'connect' => 'mysql_connect',
'host' => 'localhost',
'login' => 'user',
'password' => 'password',
'database' => 'project_name-test',
'prefix' => '');
}
?>

View File

@@ -1,74 +0,0 @@
<?php
/* SVN FILE: $Id: inflections.php,v 1.1.1.1 2006-05-24 19:14:24 uid815 Exp $ */
/**
* Custom Inflected Words.
*
* This file is used to hold words that are not matched in the normail Inflector::pluralize() and
* Inflector::singularize()
*
* PHP versions 4 and %
*
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
* Copyright (c) 2006, Cake Software Foundation, Inc.
* 1785 E. Sahara Avenue, Suite 490-204
* Las Vegas, Nevada 89104
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @filesource
* @copyright Copyright (c) 2006, Cake Software Foundation, Inc.
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
* @package cake
* @subpackage cake.app.config
* @since CakePHP v 1.0.0.2312
* @version $Revision: 1.1.1.1 $
* @modifiedby $LastChangedBy: phpnut $
* @lastmodified $Date: 2006-05-24 19:14:24 $
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
*/
/**
* This is a key => value array of regex used to match words.
* If key matches then the value is returned.
*
* $pluralRules = array('/(s)tatus$/i' => '\1\2tatuses', '/^(ox)$/i' => '\1\2en', '/([m|l])ouse$/i' => '\1ice');
*/
$pluralRules = array();
/**
* This is a key only array of plural words that should not be inflected.
* Notice the last comma
*
* $uninflectedPlural = array('.*[nrlm]ese', '.*deer', '.*fish', '.*measles', '.*ois', '.*pox');
*/
$uninflectedPlural = array();
/**
* This is a key => value array of plural irregular words.
* If key matches then the value is returned.
*
* $irregularPlural = array('atlas' => 'atlases', 'beef' => 'beefs', 'brother' => 'brothers')
*/
$irregularPlural = array();
/**
* This is a key => value array of regex used to match words.
* If key matches then the value is returned.
*
* $singularRules = array('/(s)tatuses$/i' => '\1\2tatus', '/(matr)ices$/i' =>'\1ix','/(vert|ind)ices$/i')
*/
$singularRules = array();
/**
* This is a key only array of singular words that should not be inflected.
* You should not have to change this value below if you do change it use same format
* as the $uninflectedPlural above.
*/
$uninflectedSingular = $uninflectedPlural;
/**
* This is a key => value array of singular irregular words.
* Most of the time this will be a reverse of the above $irregularPlural array
* You should not have to change this value below if you do change it use same format
*
* $irregularSingular = array('atlases' => 'atlas', 'beefs' => 'beef', 'brothers' => 'brother')
*/
$irregularSingular = array_flip($irregularPlural);
?>

View File

@@ -1,51 +0,0 @@
<?php
/* SVN FILE: $Id: routes.php,v 1.1.1.1 2006-05-24 19:14:24 uid815 Exp $ */
/**
* Short description for file.
*
* In this file, you set up routes to your controllers and their actions.
* Routes are very important mechanism that allows you to freely connect
* different urls to chosen controllers and their actions (functions).
*
* PHP versions 4 and 5
*
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
* Copyright (c) 2006, Cake Software Foundation, Inc.
* 1785 E. Sahara Avenue, Suite 490-204
* Las Vegas, Nevada 89104
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @filesource
* @copyright Copyright (c) 2006, Cake Software Foundation, Inc.
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
* @package cake
* @subpackage cake.app.config
* @since CakePHP v 0.2.9
* @version $Revision: 1.1.1.1 $
* @modifiedby $LastChangedBy: phpnut $
* @lastmodified $Date: 2006-05-24 19:14:24 $
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
*/
/**
* Here, we are connecting '/' (base path) to controller called 'Pages',
* its action called 'display', and we pass a param to select the view file
* to use (in this case, /app/views/pages/home.thtml)...
*/
$Route->connect ('/', array('controller'=>'results', 'action'=>'', ''));
/**
* ...and connect the rest of 'Pages' controller's urls.
*/
$Route->connect ('/pages/*', array('controller'=>'pages', 'action'=>'display'));
/**
* Then we connect url '/test' to our test controller. This is helpfull in
* developement.
*/
$Route->connect ('/tests', array('controller'=>'tests', 'action'=>'index'));
?>

View File

@@ -1,30 +0,0 @@
CREATE TABLE `acos` (
`id` int(11) NOT NULL auto_increment,
`model` varchar(255) NOT NULL default '',
`object_id` int(11) default NULL,
`alias` varchar(255) NOT NULL default '',
`lft` int(11) default NULL,
`rght` int(11) default NULL,
PRIMARY KEY (`id`)
);
CREATE TABLE `aros` (
`id` int(11) NOT NULL auto_increment,
`model` varchar(255) NOT NULL default '',
`user_id` int(11) default NULL,
`alias` varchar(255) NOT NULL default '',
`lft` int(11) default NULL,
`rght` int(11) default NULL,
PRIMARY KEY (`id`)
);
CREATE TABLE `aros_acos` (
`id` int(11) NOT NULL auto_increment,
`aro_id` int(11) default NULL,
`aco_id` int(11) default NULL,
`_create` int(1) NOT NULL default '0',
`_read` int(1) NOT NULL default '0',
`_update` int(1) NOT NULL default '0',
`_delete` int(11) NOT NULL default '0',
PRIMARY KEY (`id`)
);

View File

@@ -1,11 +0,0 @@
-- @copyright Copyright (c) 2006, Cake Software Foundation, Inc.
-- @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
-- @since CakePHP v 0.10.8.1997
-- @version $Revision: 1.1.1.1 $
CREATE TABLE cake_sessions (
id varchar(255) NOT NULL default '',
data text,
expires int(11) default NULL,
PRIMARY KEY (id)
);

View File

@@ -1,7 +0,0 @@
<?php
class ApplicationsController extends AppController {
var $name = 'Applications';
}
?>

View File

@@ -1,7 +0,0 @@
<?php
class IntentionsController extends AppController {
var $name = 'Intentions';
}
?>

View File

@@ -1,7 +0,0 @@
<?php
class IssuesController extends AppController {
var $name = 'Issues';
}
?>

View File

@@ -1,122 +0,0 @@
<?php
/* Include the CSV library. It would be nice to make this OO sometime */
vendor('csv/csv');
class ResultsController extends AppController {
var $name = 'Results';
/**
* Model's this controller uses
* @var array
*/
var $uses = array('Application','Result');
/**
* Cake Helpers
* @var array
*/
var $helpers = array('Html', 'Javascript', 'Export', 'Pagination','Time');
/**
* Pagination helper variable array
* @access public
* @var array
*/
var $pagination_parameters = array();
/**
* Will hold a sanitize object
* @var object
*/
var $Sanitize;
/**
* Constructor - sets up the sanitizer and the pagination
*/
function ResultsController()
{
parent::AppController();
$this->Sanitize = new Sanitize();
// Pagination Stuff
$this->pagination_parameters['show'] = empty($_GET['show'])? '10' : $this->Sanitize->paranoid($_GET['show']);
$this->pagination_parameters['sortBy'] = empty($_GET['sort'])? 'created' : $this->Sanitize->paranoid($_GET['sort']);
$this->pagination_parameters['direction'] = empty($_GET['direction'])? 'desc': $this->Sanitize->paranoid($_GET['direction']);
$this->pagination_parameters['page'] = empty($_GET['page'])? '1': $this->Sanitize->paranoid($_GET['page']);
$this->pagination_parameters['order'] = $this->modelClass.'.'.$this->pagination_parameters['sortBy'].' '.strtoupper($this->pagination_parameters['direction']);
}
/**
* Front page will show the graph
*/
function index()
{
// Products dropdown
$this->set('products', $this->Application->getApplications());
// Fill in all the data passed in $_GET
$this->set('url_params',$this->decodeAndSanitize($this->params['url']));
// We'll need to include the graphing libraries
$this->set('include_graph_libraries', true);
// Core data to show on page
$this->set('descriptionAndTotalsData',$this->Result->getDescriptionAndTotalsData($this->params['url']));
}
/**
* Display a table of user comments
*/
function comments()
{
// Products dropdown
$this->set('products', $this->Application->getApplications());
// Fill in all the data passed in $_GET
$this->set('url_params',$this->decodeAndSanitize($this->params['url']));
// Pagination settings
$paging['style'] = 'html';
$paging['link'] = "/results/comments/?product=".urlencode($this->params['url']['product'])."&start_date=".urlencode($this->params['url']['start_date'])."&end_date=".urlencode($this->params['url']['end_date'])."&show={$this->pagination_parameters['show']}&sort={$this->pagination_parameters['sortBy']}&direction={$this->pagination_parameters['direction']}&page=";
$paging['count'] = $this->Result->getCommentCount($this->params['url']);
$paging['page'] = $this->pagination_parameters['page'];
$paging['limit'] = $this->pagination_parameters['show'];
$paging['show'] = array('10','25','50');
// No point in showing them an error if they click on "show 50" but they are
// already on the last page.
if ($paging['count'] < ($this->pagination_parameters['page'] * ($this->pagination_parameters['show']/2))) {
$this->pagination_parameters['page'] = $paging['page'] = 1;
}
// Set pagination array
$this->set('paging',$paging);
// Core data to show on page
$this->set('commentsData',$this->Result->getComments($this->params['url'], $this->pagination_parameters));
}
/**
* Display a csv
*/
function csv()
{
// Get rid of the header/footer/etc.
$this->layout = null;
// Our CSV library sends headers and everything. Keep the view empty!
csv_send_csv($this->Result->getCsvExportData($this->params['url']));
// I'm not exiting here in case someone is going to use post callback stuff.
// In development, that means extra lines get added to our CSVs, but in
// production it should be clean.
}
}
?>

View File

@@ -1,27 +0,0 @@
<?php
/* SVN FILE: $Id: index.php,v 1.1.1.1 2006-05-24 19:14:24 uid815 Exp $ */
/**
* PHP versions 4 and 5
*
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
* Copyright (c) 2006, Cake Software Foundation, Inc.
* 1785 E. Sahara Avenue, Suite 490-204
* Las Vegas, Nevada 89104
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @filesource
* @copyright Copyright (c) 2006, Cake Software Foundation, Inc.
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
* @package cake
* @subpackage cake.app
* @since CakePHP v 0.10.0.1076
* @version $Revision: 1.1.1.1 $
* @modifiedby $LastChangedBy: phpnut $
* @lastmodified $Date: 2006-05-24 19:14:24 $
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
*/
require 'webroot'.DIRECTORY_SEPARATOR.'index.php';
?>

View File

@@ -1,24 +0,0 @@
<?php
class Application extends AppModel {
var $name = 'Application';
var $hasOne = array('Result');
var $hasAndBelongsToMany = array(
'Intention' => array('className' => 'Intention'),
'Issue' => array('className' => 'Issue')
);
/**
* This was added because running findAll() on this model does a left join on the
* results table which takes around 10 seconds to grab all the data. All I want
* is a list of the applications...
*
* @return array rows representing each application
*/
function getApplications()
{
return $this->query('SELECT * FROM `applications` ORDER BY `id`');
}
}
?>

View File

@@ -1,12 +0,0 @@
<?php
class Intention extends AppModel {
var $name = 'Intention';
var $hasOne = array('Result');
var $hasAndBelongsToMany = array('Application' =>
array('className' => 'Application')
);
}
?>

View File

@@ -1,10 +0,0 @@
<?php
class Issue extends AppModel {
var $name = 'Issue';
var $hasAndBelongsToMany = array(
'Application' => array('className' => 'Application'),
'Result' => array('className' => 'Result')
);
}
?>

View File

@@ -1,339 +0,0 @@
<?php
class Result extends AppModel {
var $name = 'Result';
var $belongsTo = array('Application', 'Intention');
var $hasAndBelongsToMany = array('Issue' =>
array('className' => 'Issue')
);
/**
* Count's all the comments, according to the parameters.
* @param array URL parameters
* @return Cake's findCount() value
*/
function getCommentCount($params)
{
// Clean parameters
$params = $this->cleanArrayForSql($params);
// We only want to see rows with comments
$_conditions = array("comments NOT LIKE ''");
if (!empty($params['start_date'])) {
$_timestamp = strtotime($params['start_date']);
if (!($_timestamp == -1) || $_timestamp == false) {
$_date = date('Y-m-d H:i:s', $_timestamp);//sql format
array_push($_conditions, "`created` >= '{$_date}'");
}
}
if (!empty($params['end_date'])) {
$_timestamp = strtotime($params['end_date']);
if (!($_timestamp == -1) || $_timestamp == false) {
$_date = date('Y-m-d H:i:s', $_timestamp);//sql format
array_push($_conditions, "`created` <= '{$_date}'");
}
}
if (!empty($params['product'])) {
// product's come in looking like:
// Mozilla Firefox 1.5.0.1
$_exp = explode(' ',urldecode($params['product']));
if(count($_exp) == 3) {
$_product = $_exp[0].' '.$_exp[1];
$_version = $_exp[2];
/* Note that 'Application' is not the actual name of the table! You can
* thank cake for that.*/
array_push($_conditions, "`Application`.`name` LIKE '%{$_product}%'");
array_push($_conditions, "`Application`.`version` LIKE '%{$_version}%'");
} else {
// defaults I guess?
array_push($_conditions, "`Application`.`name` LIKE 'Mozilla Firefox'");
array_push($_conditions, "`Application`.`version` LIKE '1.5'");
}
} else {
// I'm providing a default here, because otherwise all results will be
// returned (across all applications) and that is not desired
array_push($_conditions, "`Application`.`name` LIKE 'Mozilla Firefox'");
array_push($_conditions, "`Application`.`version` LIKE '1.5'");
}
// Do the actual query
$comments = $this->findCount($_conditions);
return $comments;
}
/**
* Will retrieve all the comments within param's and pagination's parameters
* @param array URL parameters
* @param array pagination values from the controller
* @param boolean if privacy is true phone numbers and email addresses will be
* masked
* @return cake result set
*/
function getComments($params, $pagination, $privacy=true)
{
$params = $this->cleanArrayForSql($params);
// We only want to see rows with comments
$_conditions = array("comments NOT LIKE ''");
if (!empty($params['start_date'])) {
$_timestamp = strtotime($params['start_date']);
if (!($_timestamp == -1) || $_timestamp == false) {
$_date = date('Y-m-d H:i:s', $_timestamp);//sql format
array_push($_conditions, "`created` >= '{$_date}'");
}
}
if (!empty($params['end_date'])) {
$_timestamp = strtotime($params['end_date']);
if (!($_timestamp == -1) || $_timestamp == false) {
$_date = date('Y-m-d H:i:s', $_timestamp);//sql format
array_push($_conditions, "`created` <= '{$_date}'");
}
}
if (!empty($params['product'])) {
// product's come in looking like:
// Mozilla Firefox 1.5.0.1
$_exp = explode(' ',urldecode($params['product']));
if(count($_exp) == 3) {
$_product = $_exp[0].' '.$_exp[1];
$_version = $_exp[2];
/* Note that 'Application' is not the actual name of the table! You can
* thank cake for that.*/
array_push($_conditions, "`Application`.`name` LIKE '%{$_product}%'");
array_push($_conditions, "`Application`.`version` LIKE '%{$_version}%'");
} else {
// defaults I guess?
array_push($_conditions, "`Application`.`name` LIKE 'Mozilla Firefox'");
array_push($_conditions, "`Application`.`version` LIKE '1.5'");
}
} else {
// I'm providing a default here, because otherwise all results will be
// returned (across all applications) and that is not desired
array_push($_conditions, "`Application`.`name` LIKE 'Mozilla Firefox'");
array_push($_conditions, "`Application`.`version` LIKE '1.5'");
}
$comments = $this->findAll($_conditions, null, $pagination['order'], $pagination['show'], $pagination['page']);
if ($privacy) {
// Pull out all the email addresses and phone numbers
foreach ($comments as $var => $val) {
// Handle foo@bar.com
$_email_regex = '/\ ?(.+)?@(.+)?\.(.+)?\ ?/';
$comments[$var]['Result']['comments'] = preg_replace($_email_regex,'$1@****.$3',$comments[$var]['Result']['comments']);
$comments[$var]['Result']['intention_text'] = preg_replace($_email_regex,'$1@****.$3',$comments[$var]['Result']['intention_text']);
// Handle xxx-xxx-xxxx
$_phone_regex = '/([0-9]{3})[ .-]?[0-9]{4}/';
$comments[$var]['Result']['comments'] = preg_replace($_phone_regex,'$1-****',$comments[$var]['Result']['comments']);
$comments[$var]['Result']['intention_text'] = preg_replace($_phone_regex,'$1-****',$comments[$var]['Result']['intention_text']);
}
}
return $comments;
}
/**
* This function runs the query to get the export data for the CSV file.
*
* @param array URL parameters
* @param boolean if privacy is true phone numbers and email addresses will be
* masked
* @return array two dimensional array that should be pretty easy to transform
* into a CSV.
*/
function getCsvExportData($params, $privacy=true)
{
$params = $this->cleanArrayForSql($params);
// We have to use a left join here because there isn't always an intention
$_query = "
SELECT
`results`.`id`,
`results`.`created`,
`results`.`intention_text` as `intention_other`,
`results`.`comments`,
`intentions`.`description` as `intention`
FROM `results`
LEFT JOIN `intentions` ON `results`.`intention_id`=`intentions`.`id`
INNER JOIN `applications` ON `applications`.`id` = `results`.`application_id`
WHERE
1=1
";
if (!empty($params['start_date'])) {
$_timestamp = strtotime($params['start_date']);
if (!($_timestamp == -1) || $_timestamp == false) {
$_date = date('Y-m-d H:i:s', $_timestamp);//sql format
$_query .= " AND `results`.`created` >= '{$_date}'";
}
}
if (!empty($params['end_date'])) {
$_timestamp = strtotime($params['end_date']);
if (!($_timestamp == -1) || $_timestamp == false) {
$_date = date('Y-m-d H:i:s', $_timestamp);//sql format
$_query .= " AND `results`.`created` <= '{$_date}'";
}
}
if (!empty($params['product'])) {
// product's come in looking like:
// Mozilla Firefox 1.5.0.1
$_exp = explode(' ',urldecode($params['product']));
if(count($_exp) == 3) {
$_product = $_exp[0].' '.$_exp[1];
$_version = $_exp[2];
$_query .= " AND `applications`.`name` LIKE '{$_product}'";
$_query .= " AND `applications`.`version` LIKE '{$_version}'";
} else {
// defaults I guess?
$_query .= " AND `applications`.`name` LIKE 'Mozilla Firefox'";
$_query .= " AND `applications`.`version` LIKE '1.5'";
}
} else {
// I'm providing a default here, because otherwise all results will be
// returned (across all applications) and that is not desired
$_query .= " AND `applications`.`name` LIKE 'Mozilla Firefox'";
$_query .= " AND `applications`.`version` LIKE '1.5'";
}
$_query .= " ORDER BY `results`.`created` ASC";
$res = $this->query($_query);
// Since we're exporting to a CSV, we need to flatten the results into a 2
// dimensional table array
$newdata = array();
foreach ($res as $result) {
$newdata[] = array_merge($result['results'], $result['intentions']);
}
if ($privacy) {
// Pull out all the email addresses and phone numbers
foreach ($newdata as $var => $val) {
// Handle foo@bar.com
$_email_regex = '/\ ?(.+)?@(.+)?\.(.+)?\ ?/';
$newdata[$var]['comments'] = preg_replace($_email_regex,'$1@****.$3',$newdata[$var]['comments']);
$newdata[$var]['intention_other'] = preg_replace($_email_regex,'$1@****.$3',$newdata[$var]['intention_other']);
// Handle xxx-xxx-xxxx
$_phone_regex = '/([0-9]{3})[ .-]?[0-9]{4}/';
$newdata[$var]['comments'] = preg_replace($_phone_regex,'$1-****',$newdata[$var]['comments']);
$newdata[$var]['intention_other'] = preg_replace($_phone_regex,'$1-****',$newdata[$var]['intention_other']);
}
}
// Our CSV library just prints out everything in order, so we have to put the
// column labels on here ourselves
$newdata = array_merge(array(array_keys($newdata[0])), $newdata);
return $newdata;
}
/**
* Will retrieve the information used for graphing.
* @param the url parameters (unescaped)
* @return a result set
*/
function getDescriptionAndTotalsData($params)
{
// Clean parameters for inserting into SQL
$params = $this->cleanArrayForSql($params);
/* It would be nice to drop something like this in the SELECT:
*
* CONCAT(COUNT(*)/(SELECT COUNT(*) FROM our_giant_query_all_over_again)*100,'%') AS `percentage`
*/
$_query = "
SELECT
issues.description,
COUNT( DISTINCT results.id ) AS total
FROM
issues
LEFT JOIN
issues_results ON issues_results.issue_id=issues.id
LEFT JOIN results ON results.id=issues_results.result_id AND results.application_id=applications.id
JOIN applications_issues ON applications_issues.issue_id=issues.id
JOIN applications ON applications.id=applications_issues.application_id
WHERE 1=1
";
if (!empty($params['start_date'])) {
$_timestamp = strtotime($params['start_date']);
if (!($_timestamp == -1) || $_timestamp == false) {
$_date = date('Y-m-d H:i:s', $_timestamp);//sql format
$_query.= " AND `results`.`created` >= '{$_date}'";
}
}
if (!empty($params['end_date'])) {
$_timestamp = strtotime($params['end_date']);
if (!($_timestamp == -1) || $_timestamp == false) {
$_date = date('Y-m-d H:i:s', $_timestamp);//sql format
$_query .= " AND `results`.`created` <= '{$_date}'";
}
}
if (!empty($params['product'])) {
// product's come in looking like:
// Mozilla Firefox 1.5.0.1
$_exp = explode(' ',urldecode($params['product']));
if(count($_exp) == 3) {
$_product = $_exp[0].' '.$_exp[1];
$_version = $_exp[2];
$_query .= " AND `applications`.`name` LIKE '{$_product}'";
$_query .= " AND `applications`.`version` LIKE '{$_version}'";
} else {
// defaults I guess?
$_query .= " AND `applications`.`name` LIKE 'Mozilla Firefox'";
$_query .= " AND `applications`.`version` LIKE '1.5'";
}
} else {
// I'm providing a default here, because otherwise all results will be
// returned (across all applications) and that is not desired
$_query .= " AND `applications`.`name` LIKE 'Mozilla Firefox'";
$_query .= " AND `applications`.`version` LIKE '1.5'";
}
$_query .= " GROUP BY `issues`.`description`
ORDER BY `issues`.`description` DESC";
return $this->query($_query);
}
}
?>

View File

@@ -1,188 +0,0 @@
<?php
/**
* Functions that take a db result and export it to CSV.
* Usage example:
* <code>
* if ($_GET['csv'])
* {
* $res=db_query("SELECT * FROM fic_courses");
* csv_send_csv($res);
* exit;
* }
* </code>
* @package libs
* @subpackage csv
* @author Richard Faaberg <faabergr@onid.orst.edu>
* @author Mike Morgan <mike.morgan@oregonstate.edu>
*/
/**
* Use a resource or two dimensional array, then send the CSV results to user.
* @param mixed $res MySQL resource / result, or a two dimensional array
* @param string $name name of the export file
* @return bool true if file sent, false otherwise
*/
function csv_send_csv($res,$name=null)
{
// set name of the export file
$filename=(is_null($name))?'export-'.date('Y-m-d').'.csv':$name.'.csv';
// check for valid resource
if ( is_resource($res) )
{
$csv=csv_export_to_csv($res);
}
elseif( is_array($res) && !empty($res) )
{
foreach ($res as $row)
{
if ( !is_array($row) )
;
else
$csv[] = csv_array_to_csv($row)."\n";
}
}
if ( is_array($csv) )
{
// stream csv to user
header("Content-type: application/x-csv");
header('Content-disposition: inline; filename="'.$filename.'"');
header('Cache-Control: private');
header('Pragma: public');
foreach ($csv as $row)
{
echo $row;
}
return true;
}
return false;
}
/**
* Replace quotes inside of a field with double quotes, which is something CSV requires.
* @param string $string unquoted quotes
* @return string $string quoted quotes
*/
function csv_fix_quotes($string)
{
return preg_replace('/"/','""',$string);
}
/**
* Replace line breaks with commas trailed by a space.
* @param string $string string containing line breaks
* @param string string without line breaks
*/
function csv_fix_line_breaks($string)
{
return preg_replace('/(\n\r|\r)/','\n',$string);
}
/**
* Replaces instances of double quotes in a string with a single quote.
* @param string $string the string to perform the replacement on
* @return string the string with "" replaced by "
*/
function csv_unfix_quotes($string)
{
return preg_replace('/""/', '"', $string);
}
/**
* Place quotes outside of every field, which inherently solves space, line break issues.
* @param string $string
* @return string $string with quotes around it
*/
function csv_add_quotes($string)
{
return '"'.$string.'"';
}
/**
* Removes quotes from the beginning and the end of a string.
* @param string $string the string to remove the quotes from
* @return string the string, sans quotes at the beginning and end
*/
function csv_remove_quotes($string)
{
$pattern = "/^\"(.*)\"$/";
$replacement = "$1";
return preg_replace($pattern, $replacement, $string);
}
/**
* Convert an array into a CSV string with quotes around each value.
* @param array $array
* @return string the values in $array surrounded by quotes and separated by commas
*/
function csv_array_to_csv($array)
{
$csv_arr = array();
foreach ($array as $value)
{
$csv_arr[]=csv_add_quotes(csv_fix_quotes(csv_fix_line_breaks($value)));
}
$csv_string=implode(',',$csv_arr);
return $csv_string;
}
/**
* Convert a CSV string into an array.
* Please use sparingly - this creates temp files
* @param string $string the CSV string
* @return array the elements from the CSV string in an array
*/
function csv_csv_to_array($string)
{
$return = array();
$length = strlen($string);
// create a temp file and write the string to it
$tmpfname = tempnam('/tmp', 'csvlib');
$fh = fopen($tmpfname, 'w');
fwrite($fh, $string);
fclose($fh);
// open the file for csv parsing
$csvh = fopen($tmpfname, 'r');
while (($arraydata = fgetcsv($csvh, $length, ',')) !== false)
{
$return = array_merge($return, $arraydata);
}
fclose($csvh);
unlink($tmpfname);
return $return;
}
/**
* Read a CSV file into a two dimensional array
* It returns all the rows in the file, so if the first row are headers, you'd need to take care of that in the returned array
* @param string $filepath the path to the csv file
* @param string $delimiter delimiter, default to ','
* @param string $enclosure enclosure character, default to '"'
* @return &array the two dimensional array with the csv file content, or an empty if an error occured
*/
function &csv_csv_file_to_array($filepath, $delimiter=',', $enclosure='"')
{
$return = array();
if (!file_exists($filepath) || !is_readable($filepath))
return $return;
$fh =& fopen($filepath, 'r');
$size = filesize($filepath)+1;
while ($data =& fgetcsv($fh, $size, $delimiter, $enclosure))
{
$return[] = $data;
}
fclose($fh);
return $return;
}
?>

View File

@@ -1,11 +0,0 @@
<div id="t_footer">
</div>
<!-- t_wrapper -->
</div>
<!-- t_border -->
</div>
</body>
</html>

View File

@@ -1,26 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Mozilla Uninstall Survey Data</title>
<meta name="author" content="Mozilla Corporation" />
<meta name="copyright" content="Mozilla Corporation" />
<?php echo $html->charset('UTF-8'); ?>
<?php echo $html->css('screen'); ?>
<?php if (isset($include_graph_libraries) && $include_graph_libraries):
echo $javascript->link('mochikit/MochiKit.js');
echo $javascript->link('plotkit/Base.js');
echo $javascript->link('plotkit/Layout.js');
echo $javascript->link('plotkit/Canvas.js');
echo $javascript->link('plotkit/SweetCanvas.js');
endif; ?>
</head>
<body>
<div id="t_border">
<div id="t_wrapper">
<a class="skipnav" href="#t_content">Skip Navigation Links</a>
<div id="t_header">
<div id="t_title">
<h1>Mozilla Firefox Uninstall Survey Data</h1>
</div>
</div>

View File

@@ -1,6 +0,0 @@
<div id="t_nav">
<ul>
<li><?php echo $html->link('Results', '/results'); ?></li>
<li><?php echo $html->link('Comments', '/results/comments'); ?></li>
</ul>
</div>

View File

@@ -1,36 +0,0 @@
<?php
/**
* When we're exporting data, we end up having to pass all the parameters
* via $_GET. Since we're doing this a few times per page (each graph, and the
* export hrefs) this helper should make that easier.
*/
class ExportHelper
{
/**
* Method to collect the current $_GET parameters and build another string from
* them.
*
* @param string cake URL that you want prepended to the result. eg: reports/graph/
* @param array the array of GET variables to add. These need to be
* pre-sanitized to print in html! This is designed to
* be used from the calling controller like:
* $params = $this->sanitize->html($url_parameters);
* @param string string to put between url and arguments (probably either '?' or
* '&')
* @param array array of strings which will be ignored
* @return string string with the url variables appeneded to it
*/
function buildUrlString($url, $params, $seperator='?', $ignore=array('url'))
{
$arguments = '';
foreach ($params as $var => $val) {
if (!in_array($var, $ignore)) {
$arguments .= empty($arguments) ? "{$var}={$val}" : "&amp;{$var}={$val}";
}
}
return "{$url}{$seperator}{$arguments}";
}
}
?>

View File

@@ -1,196 +0,0 @@
<?php
class PaginationHelper {
var $helpers = array('Html','Ajax');
var $_pageDetails = array();
var $link = '';
var $show = array();
var $page;
var $style;
/**
* Sets the default pagination options.
*
* @param array $paging an array detailing the page options
*/
function setPaging($paging)
{
if(!empty($paging))
{
$this->link = $paging['link'];
$this->show = $paging['show'];
$this->page = $paging['page'];
$this->style = $paging['style'];
$pageCount = ceil($paging['count'] / $paging['limit'] );
$this->_pageDetails = array(
'page'=>$paging['page'],
'recordCount'=>$paging['count'],
'pageCount' =>$pageCount,
'nextPage'=> ($paging['page'] < $pageCount) ? $paging['page']+1 : '',
'previousPage'=> ($paging['page']>1) ? $paging['page']-1 : '',
'limit'=>$paging['limit']
);
return true;
}
return false;
}
/**
* Displays limits for the query
*
* @param string $text - text to display before limits
* @param string $separator - display a separate between limits
*
**/
function show($text=null, $separator=null)
{
if (empty($this->_pageDetails)) { return false; }
if ( !empty($this->_pageDetails['recordCount']) )
{
$t = '';
if(is_array($this->show))
{
$t = $text.$separator;
foreach($this->show as $value)
{
$link = preg_replace('/show=(.*?)&/','show='.$value.'&',$this->link);
if($this->_pageDetails['limit'] == $value)
{
$t .= '<em>'.$value.'</em>'.$separator;
}
else
{
if($this->style == 'ajax')
{
$t .= $this->Ajax->linkToRemote($value, array("fallback"=>$this->action."#","url" => $link.$this->_pageDetails['page'],"update" => "ajax_update","method"=>"get")).$separator;
}
else
{
$t .= $this->Html->link($value,$link.$this->_pageDetails['page']).$separator;
}
}
}
}
return $t;
}
return false;
}
/**
* Displays current result information
*
* @param string $text - text to preceeding the number of results
*
**/
function result($text)
{
if (empty($this->_pageDetails)) { return false; }
if ( !empty($this->_pageDetails['recordCount']) )
{
if($this->_pageDetails['recordCount'] > $this->_pageDetails['limit'])
{
$start_row = $this->_pageDetails['page'] > 1 ? (($this->_pageDetails['page']-1)*$this->_pageDetails['limit'])+1:'1';
$end_row = ($this->_pageDetails['recordCount'] < ($start_row + $this->_pageDetails['limit']-1)) ? $this->_pageDetails['recordCount'] : ($start_row + $this->_pageDetails['limit']-1);
$t = $text.$start_row.'-'.$end_row.' of '.$this->_pageDetails['recordCount'];
}
else
{
$t = $text.$this->_pageDetails['recordCount'];
}
return $t;
}
return false;
}
/**
* Returns a list of page numbers separated by $separator
*
* @param string $separator - defaults to null
*
**/
function pageNumbers($separator=null)
{
if (empty($this->_pageDetails) || $this->_pageDetails['pageCount'] == 1) { return false; }
$t = array();
$text = '';
$pc = 1;
do
{
if($pc == $this->_pageDetails['page'])
{
$text = '<em>'.$pc.'</em>';
}
else
{
if($this->style == 'ajax')
{
$text = $this->Ajax->linkToRemote($pc, array("fallback"=>$this->action."#","url" =>$this->link.$pc,"update" => "ajax_update","method"=>"get"));
}
else
{
$text = $this->Html->link($pc,$this->link.$pc);
}
}
$t[] = $text;
$pc++;
}
while ($pc<=$this->_pageDetails['pageCount']);
$t = implode($separator, $t);
return $t;
}
/**
* Displays a link to the previous page, where the page doesn't exist then
* display the $text
*
* @param string $text - text display: defaults to next
*
**/
function prevPage($text='prev')
{
if (empty($this->_pageDetails)) { return false; }
if ( !empty($this->_pageDetails['previousPage']) )
{
if($this->style == 'ajax')
{
$t = $this->Ajax->linkToRemote($text, array("fallback"=>$this->action."#","url" => $this->link.$this->_pageDetails['previousPage'],"update" => "ajax_update","method"=>"get"));
}
else
{
$t = $this->Html->link($text,$this->link.$this->_pageDetails['previousPage']);
}
return $t;
}
return false;
}
/**
* Displays a link to the next page, where the page doesn't exist then
* display the $text
*
* @param string $text - text to display: defaults to next
*
**/
function nextPage($text='next')
{
if (empty($this->_pageDetails)) { return false; }
if (!empty($this->_pageDetails['nextPage']))
{
if($this->style == 'ajax')
{
$t = $this->Ajax->linkToRemote($text, array("fallback"=>$this->action."#","url" => $this->link.$this->_pageDetails['nextPage'],"update" => "ajax_update","method"=>"get"));
}
else
{
$t = $this->Html->link($text,$this->link.$this->_pageDetails['nextPage']);
}
return $t;
}
return false;
}
}
?>

View File

@@ -1,8 +0,0 @@
<?php echo $this->renderElement( 'header' ); ?>
<?php echo $this->renderElement( 'nav' ); ?>
<div id="t_content_container">
<div id="t_content">
<?php echo $content_for_layout;?>
</div>
</div>
<?php echo $this->renderElement( 'footer'); ?>

View File

@@ -1,51 +0,0 @@
<h1><?php echo Inflector::humanize($this->name); ?></h1>
<div id="queryform">
<?php echo $html->formTag('/results/comments/','get'); ?>
<span>
<label for="start_date">Start Date:</label>
<input type="text" name="start_date" id="start_date" value="<? echo isset($url_params['start_date']) ? $url_params['start_date'] : ''; ?>" />
<label for="end_date">End Date:</label>
<input type="text" name="end_date" id="end_date" value="<? echo isset($url_params['end_date']) ? $url_params['end_date'] : ''; ?>" />
</span>
<label for="product">Product:</label>
<select name="product" id="product">
<?php
foreach ($products as $select) :
$product = $select['applications']['name'].' '.$select['applications']['version'];
$selected = ($product == trim($url_params['product'])) ? ' selected="selected" ' : '';
?>
<option<?=$selected?>><?=$product?></option>
<?php endforeach; ?>
</select>
<input type="submit" name="submit" id="submit" value="Go" />
</form>
<br />
<span><small>Date format is yyyy-mm-dd. A blank date will use the largest possible range.</small></span>
</div>
<?php if (!empty($commentsData)) : ?>
<table class="comments" summary="User submitted comments.">
<tr><th>Date Recorded</th><th>Comment</th></tr>
<?php foreach ($commentsData as $var => $val) : ?>
<tr><td><?php echo $time->niceShort($val['Result']['created']); ?></td><td><?php echo nl2br(htmlspecialchars($val['Result']['comments'])); ?></td></tr>
<?php endforeach; ?>
</table>
<?php if($pagination->setPaging($paging)):?>
<ul id="page-numbers">
<li><?php echo $pagination->show('Show ', ' '); ?></li>
<li><?php echo $pagination->result('Results: '); ?></li>
<li><?php echo $pagination->pageNumbers(' '); ?></li>
</ul>
<?php endif;?>
<?php else: ?>
<div id="notice">There is no data available for your parameters. Please review your search criteria.</div>
<?php endif; ?>

View File

@@ -1,91 +0,0 @@
<h1><?php echo Inflector::humanize($this->name); ?></h1>
<div id="queryform">
<?php echo $html->formTag('/results/','get'); ?>
<span>
<label for="start_date">Start Date:</label>
<input type="text" name="start_date" id="start_date" value="<? echo isset($url_params['start_date']) ? $url_params['start_date'] : ''; ?>" />
<label for="end_date">End Date:</label>
<input type="text" name="end_date" id="end_date" value="<? echo isset($url_params['end_date']) ? $url_params['end_date'] : ''; ?>" />
</span>
<label for="product">Product:</label>
<select name="product" id="product">
<?php
foreach ($products as $select) :
$product = $select['applications']['name'].' '.$select['applications']['version'];
$selected = ($product == trim($url_params['product'])) ? ' selected="selected" ' : '';
?>
<option<?=$selected?>><?=$product?></option>
<?php endforeach; ?>
</select>
<input type="submit" name="submit" id="submit" value="Go" />
</form>
<br />
<span><small>Date format is yyyy-mm-dd. A blank date will use the largest possible range.</small></span>
</div>
<?php if (!empty($descriptionAndTotalsData)) : ?>
<?php
/* Prepare data for graphing */
$_dataset = '';
$_count = 0;
$_total = 0;
/* We've got to do 2 loops here because I need the totals to calculate
* percentages.
*/
foreach ($descriptionAndTotalsData as $var => $val) {
$_total += $val[0]['total'];
}
foreach ($descriptionAndTotalsData as $var => $val) {
// We're putting this in a js string, so escape the double quotes
$_description = str_replace('"','\"',$val['issues']['description']);
$_percentage = intval(($val[0]['total'] / $_total)*100);
$_dataset .= "[{$_count}, {$val[0]['total']}, \"{$_description} (n={$val[0]['total']}, {$_percentage}%)\"], ";
$_count++;
}
$_dataset = "[{$_dataset}]";
?>
<div id="graphcontainer">
<canvas id="graph" height="400" width="800">
<table class="results" summary="Firefox Uninstallation results.">
<tr><th>Reason for uninstalling</th><th>Total</th></tr>
<?php foreach ($descriptionAndTotalsData as $var => $val) : ?>
<tr><td><?=$val['issues']['description']?></td><td><?=$val[0]['total']?></td></tr>
<?php endforeach; ?>
</table>
</canvas>
</div>
<script type="text/javascript">
var layout = new PlotKit.Layout("bar", {"barOrientation":"horizontal"});
layout.addDataset("results", <?=$_dataset?>);
layout.evaluate();
var canvas = MochiKit.DOM.getElement("graph");
var plotter = new PlotKit.SweetCanvasRenderer(canvas, layout,
{
"drawYAxis" : false,
"drawXAxis" : false,
"backgroundColor" : Color.fromHexString('#78c'),
"strokeColor" : Color.fromHexString('#777'),
"strokeWidth" : 1.0,
"enableEvents" : false
});
plotter.render();
</script>
<div id="exportbox">
<a href="<?php echo $export->buildUrlString('results/comments/',$url_params); ?>">View Any Associated Comments»</a><br />
<a href="<?php echo $export->buildUrlString('results/csv/',$url_params); ?>">Download this Data»</a>
</div>
<?php else: ?>
<div id="notice">There is no data available for your parameters. Please review your search criteria.</div>
<?php endif; ?>

View File

@@ -1,6 +0,0 @@
<IfModule mod_rewrite.c>
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-d
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^(.*)$ index.php?url=$1 [QSA,L]
</IfModule>

View File

@@ -1,116 +0,0 @@
<?php
/* SVN FILE: $Id: css.php,v 1.1.1.1 2006-05-24 19:14:24 uid815 Exp $ */
/**
* Short description for file.
*
* Long description for file
*
* PHP versions 4 and 5
*
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
* Copyright (c) 2006, Cake Software Foundation, Inc.
* 1785 E. Sahara Avenue, Suite 490-204
* Las Vegas, Nevada 89104
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @filesource
* @copyright Copyright (c) 2006, Cake Software Foundation, Inc.
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
* @package cake
* @subpackage cake.app.webroot
* @since CakePHP v 0.2.9
* @version $Revision: 1.1.1.1 $
* @modifiedby $LastChangedBy: phpnut $
* @lastmodified $Date: 2006-05-24 19:14:24 $
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
*/
/**
* Enter description here...
*/
require(CONFIGS.'paths.php');
require(CAKE.'basics.php');
require(LIBS.'folder.php');
require(LIBS.'file.php');
require(LIBS.'legacy.php');
/**
* Enter description here...
*
* @param unknown_type $path
* @param unknown_type $name
* @return unknown
*/
function make_clean_css ($path, $name)
{
require(VENDORS.'csspp'.DS.'csspp.php');
$data = file_get_contents($path);
$csspp = new csspp();
$output = $csspp->compress($data);
$ratio = 100-(round(strlen($output)/strlen($data), 3)*100);
$output = " /* file: $name, ratio: $ratio% */ " . $output;
return $output;
}
/**
* Enter description here...
*
* @param unknown_type $path
* @param unknown_type $content
* @return unknown
*/
function write_css_cache ($path, $content)
{
if (!is_dir(dirname($path)))
mkdir(dirname($path));
$cache = new File($path);
return $cache->write($content);
}
if (preg_match('|\.\.|', $url) || !preg_match('|^ccss/(.+)$|i', $url, $regs))
die('Wrong file name.');
$filename = 'css/'.$regs[1];
$filepath = CSS.$regs[1];
$cachepath = CACHE.'css'.DS.str_replace(array('/','\\'), '-', $regs[1]);
if (!file_exists($filepath))
die('Wrong file name.');
if (file_exists($cachepath))
{
$templateModified = filemtime($filepath);
$cacheModified = filemtime($cachepath);
if ($templateModified > $cacheModified)
{
$output = make_clean_css ($filepath, $filename);
write_css_cache ($cachepath, $output);
}
else
{
$output = file_get_contents($cachepath);
}
}
else
{
$output = make_clean_css ($filepath, $filename);
write_css_cache ($cachepath, $output);
}
header("Date: ".date("D, j M Y G:i:s ", $templateModified).'GMT');
header("Content-Type: text/css");
header("Expires: ".gmdate("D, j M Y H:i:s", time()+DAY)." GMT");
header("Cache-Control: cache");// HTTP/1.1
header("Pragma: cache");// HTTP/1.0
print $output;
?>

View File

@@ -1,195 +0,0 @@
/* CSS Document */
@import url("cake.forms.css");
* {
padding:0;
margin:0;
}
body {
font: 76% Verdana, Arial, Sans-serif;
color: #333;
}
img {
border:0;
}
#wrapper {
text-align:left;
}
#header {
height: 101px;
background: #0D5087 url(../img/cake.header_bg.png) repeat-x left top;
border-bottom: 1px solid #000;
}
#content {
min-height:400px;
background-color: #fff;
padding:2em 4em;
}
#footer {
text-align:center;
padding:1em 0;
font-size:smaller;
border-top:1px solid #333;
background-color: #063260;
color:#fff;
line-height:1.5;
}
#footer a {
color:#fff;
}
h1, h2, h3, h4 {
padding-bottom:0.5em;
}
h1 {
font-family:"Trebuchet MS",Verdana,Arial,Sans-serif;
}
h1, a {
color:#DB8101;
}
h1 em, a em {
color:#008BCC;
font-style: normal;
}
ul.colored a em
h2 {
font-style: italic;
font-weight: bold;
color:#666;
}
a:hover, a:hover em {
color:#A22424;
text-decoration:none;
}
#content p, #content ul, #content ol {
line-height:1.5;
padding-bottom:1em;
}
ul, ol {
margin-left:3em;
}
/* tables */
table {
width: 100%;
background-color: #fff;
border: 1px solid #333;
clear:both;
margin: 0 0 2em 0;
white-space: normal;
}
th {
background-color: #ccc;
border-top: 1px solid #fff;
border-right: 1px solid #666;
border-bottom: 1px solid #666;
text-align: center;
padding:3px;
}
table tr td {
border-right: 1px solid #ccc;
padding:4px 4px;
vertical-align:top;
text-align: center;
}
table tr.altRow td {
background: #f4f4f4;
}
/* scaffold show */
div.related {
clear:both;
display:block;
}
dl {
line-height:2em;
margin:1em;
}
dt {
font-weight: bold;
vertical-align:top;
}
dd {
margin-left:10em;
margin-top:-2em;
vertical-align:top;
}
/* scaffold buttons */
.notice {
color: #DB8101;
background-color: #ddd;
display: block;
padding: 1em;
}
.tip {
color: #DB8101;
background-color: #ddd;
display: block;
padding: 1em;
}
ul.actions {
list-style: none;
text-align:left;
margin:2em 0;
padding: 0;
}
ul.actions li {
margin-left:1em;
list-style: none;
display: inline;
}
ul.actions li a, ul.actions li input {
padding: 2px 12px;
color: #DB8101;
background-color:#ccc;
text-decoration: none;
border: 1px solid #666;
line-height: 24px;
font-weight: bold;
text-align:center;
text-decoration: none;
}
ul.actions li a:hover {
color: #DB8101;
background-color:#fff;
text-decoration: none;
}
td.listactions {
width: 14em;
text-align: center;
white-space: nowrap;
}
td.listactions a {
padding: 0px 8px;
text-align:center;
font-weight: bold;
color: #DB8101;
background-color:#ccc;
text-decoration: none;
border: 1px solid #666;
white-space: nowrap;
}
td.listactions a:hover {
color: #fff;
background-color:#DB8101;
}
/* index links */
ul.colored a {
}
ul.colored a em {
}
a {
font-weight: bold;
}

View File

@@ -1,279 +0,0 @@
/* form.css */
form {
margin: 0 4px;
font-size: 120%;
border-width: 0px 0px 0px 0px;
border-style: solid;
border-color: #DB8101;
}
form fieldset {
font-size: 100%;
border-color: #000000;
border-width: 1px 0px 0px 0px;
border-style: solid none none none;
padding: 10px;
}
form fieldset legend {
font-size: 150%;
font-weight: normal;
color: #000;
padding: 0px 5px;
}
label {
font-size: 150%;
}
label u {
font-style: normal;
text-decoration: underline;
}
input, select, textarea {
font-family: Tahoma, Arial, sans-serif;
font-size: 100%;
color: #000;
}
textarea {
overflow: auto;
}
form div {
clear: left;
display: block;
margin: 5px 0px 0px 0px;
padding: 1px 3px;
}
form fieldset div.notes {
float: right;
width: 158px;
height: auto;
margin: 0px 0px 10px 10px;
padding: 5px;
border: 1px solid #666;
background-color: #ffffe1;
color: #666;
font-size: 88%;
}
form fieldset div.notes h4 {
background-image: url(/images/icon_info.gif);
background-repeat: no-repeat;
background-position: top left;
padding: 3px 0px 3px 27px;
border-width: 0px 0px 1px 0px;
border-style: solid;
border-color: #666;
color: #666;
font-size: 110%;
}
form fieldset div.notes p {
margin: 0em 0em 1.2em 0em;
color: #666;
}
form fieldset div.notes p.last {
margin: 0em;
}
form div fieldset {
clear: none;
border-width: 0px 1px 0px 1px;
border-style: solid;
border-color: #666;
margin: 0px 0px 0px 142px;
padding: 0px 5px 5px 5px;
}
form div fieldset legend {
font-size: 100%;
padding: 0px 3px 0px 9px;
}
form div.required fieldset legend {
font-weight: bold;
}
form div label {
display: block;
float: left;
width: 200px;
background-color: #f4f4f4;
font-size: 16px;
padding: 3px 5px;
margin: 0px 0px 5px 0px;
text-align: right;
}
form div.optional label, label.optional {
font-weight: normal;
}
form div.required label, label.required {
font-weight: bold;
}
form div label.labelCheckbox, form div label.labelRadio {
float: none;
display: block;
margin: 0px 0px 5px 142px;
text-align: left;
}
form div fieldset label.labelCheckbox, form div fieldset label.labelRadio {
margin: 0px 0px 5px 0px;
}
p.error {
color: #DB8101;
background-color: #DBA941;
font-size: 14px;
padding: 1em;
}
form div input, form div select, form div textarea {
padding: 1px 3px;
margin: 0px 0px 0px 0px;
}
form div input.inputFile {
width: 211px;
}
form div select.selectOne, form div select.selectMultiple {
width: 211px;
padding: 1px 3px;
}
form div input.inputCheckbox, form div input.inputRadio, input.inputCheckbox, input.inputRadio {
display: inline;
height: 14px;
width: 14px;
background-color: transparent;
border-width: 0px;
}
form div.submit {
padding: 0px 0px 0px 140px;
clear:both;
display:block;
}
div.submit input {
padding: 2px 12px;
color: #DB8101;
background-color:#ccc;
text-decoration: none;
border: 1px solid #666;
font-size: 14px;
font-weight: bold;
text-align:center;
text-decoration: none;
width: auto;
}
div.submit input:hover {
padding: 2px 12px;
color: #fff;
background-color:#DB8101;
text-decoration: none;
border: 1px solid #666;
font-size: 14px;
font-weight: bold;
text-align:center;
text-decoration: none;
width: auto;
}
form div.submit div input.inputSubmit, form div.submit div input.inputButton {
float: right;
margin: 0px 0px 0px 5px;
}
form div small {
display: block;
margin: 0px 0px 5px 142px;
padding: 1px 3px;
font-size: 88%;
}
/* form.import.css */
form fieldset legend {
line-height: 150%;
}
form input, form select, form textarea {
background-color: #fff;
}
div.optional label:before {
content: '';
}
div.required label:before {
content: '';
}
form div label.labelCheckbox, form div label.labelRadio, label.labelCheckbox, label.labelRadio {
display: block;
width: 190px;
padding: 4px 0px 0px 18px;
text-indent: -18px;
line-height: 120%;
}
form div label.labelCheckbox input.inputCheckbox, form div label.labelRadio input.inputRadio, label.labelCheckbox input.inputCheckbox, label.labelRadio input.inputRadio {
margin: 0;
}
form div fieldset input.inputText, form div fieldset input.inputPassword, form div fieldset input.inputFile, form div fieldset textarea.inputTextarea {
width: 160px;
margin: 0px 0px 0px 18px;
}
form div label.compact {
display: inline;
width: auto;
padding: 4px 10px 0px 0px;
text-indent: 0px;
margin: 0;
}
form div.wide label {
float: none;
display: block;
}
form div label.wide {
width: 348px;
}
form div.wide input.inputText, form div.wide input.inputPassword, form div.wide input.inputFile, form div.wide select, form div.wide textarea {
width: 344px;
margin: 0;
}
form div.notes p, form div small {
line-height: 125%;
}
form div.wide small {
margin: 0px 0px 5px 0px;
}
div.date select {
width:auto;
}
select.autoWidth {
width:auto;
}
option {
padding-left:1em;
}

View File

@@ -1,9 +0,0 @@
form div,
form div label.labelCheckbox, form div label.labelRadio,
form div small,
form div label.labelCheckbox, form div label.labelRadio, label.labelCheckbox, label.labelRadio {
height: expression('1%');
}
form div fieldset input.inputText, form div fieldset input.inputPassword, form div fieldset input.inputFile, form div fieldset textarea.inputTextarea {
margin: expression('0px 0px 0px -124px');
}

View File

@@ -1,133 +0,0 @@
/* Screen Stylesheet */
/* This is temporary while we use the scaffolding */
@import url("cake.default.css");
table { clear:none; }
/* CORE STYLES */
body{
background-color:#788;
}
div#t_title{
background-color:#ddd;
height:50px;
padding-left:8px;
}
div#t_title h1{
font-size:1.7em;
padding-top:10px;
color:#677;
}
div#t_content_container{
}
div#t_content{
padding: 20px 10px 100px 10px;
margin-left:151px;
background-image:url('../img/bg.jpg');
background-position:bottom right;
background-repeat:no-repeat;
min-height:200px;
}
div#t_wrapper{
margin:0px;
padding:0px;
background-color:#fff;
}
div#t_border{
border-left:1px solid #111;
border-right:1px solid #111;
border-bottom:1px solid #111;
margin:0px 30px 0px 30px;
}
div#t_nav {
padding:20px 0px 50px 0px;
float:left;
width:151px;
}
div#t_nav ul {
list-style-type:none;
padding:2px 0px 0px 0px;
margin:0px;
}
div#t_nav ul li{
padding:2px 0px 2px 0px;
}
div#t_nav ul li a{
text-decoration:none;
font-size:.8em;
padding:6px 0px 6px 8px;
margin:0px 0px 0px 0px;
color:#566;
border:none;
}
div#t_nav ul li a:hover{
color:#f80;
}
div#t_nav h3 {
padding:5px 0px 0px 5px;
font-size:.9em;
}
div#t_footer {
clear:both;
border-top:1px solid #111;
}
div#t_content h1 {
margin-bottom:100px;
font-size:1.6em;
}
a.skipnav {
position:absolute;
visibility:hidden;
}
div#queryform {
margin: 5px 20px 5px 20px;
padding-bottom:20px;
width:700px;
}
div#queryform label {
font-size:.8em;
font-weight:bold;
}
div#queryform input[type="text"]{
width:7em;
}
div#exportbox {
}
/* Classes for graph/table data. (Generally just padding) */
.results {
padding: 5px 5px 5px 5px;
margin: 5px 5px 5px 5px;
}
div#notice {
background-color:#ecc;
border:1px dashed #daa;
text-align:center;
padding:6px 6px 6px 6px;
margin:6px 20px 6px 20px;
}
table.comments tr {
}
table.comments tr td{
text-align:left;
border-bottom: 1px solid #222;
}
div.bar_chart_label {
position: absolute;
text-align: left;
font-size: small;
color: #fff;
overflow: hidden;
z-index: 10;
}

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.2 KiB

View File

@@ -1,244 +0,0 @@
2006-04-29 v1.3.1 (bug fix release)
- Fix sendXMLHttpRequest sendContent regression
- Internet Explorer fix in MochiKit.Logging (printfire exception)
- Internet Explorer XMLHttpRequest object leak fixed in MochiKit.Async
2006-04-26 v1.3 "warp zone"
- IMPORTANT: Renamed MochiKit.Base.forward to forwardCall (for export)
- IMPORTANT: Renamed MochiKit.Base.find to findValue (for export)
- New MochiKit.Base.method as a convenience form of bind that takes the
object before the method
- New MochiKit.Base.flattenArguments for flattening a list of arguments to
a single Array
- Refactored MochiRegExp example to use MochiKit.Signal
- New key_events example demonstrating use of MochiKit.Signal's key handling
capabilities.
- MochiKit.DOM.createDOM API change for convenience: if attrs is a string,
null is used and the string will be considered the first node. This
allows for the more natural P("foo") rather than P(null, "foo").
- MochiKit Interpreter example refactored to use MochiKit.Signal and now
provides multi-line input and a help() function to get MochiKit function
signature from the documentation.
- Native Console Logging for the default MochiKit.Logging logger
- New MochiKit.Async.DeferredList, gatherResults, maybeDeferred
- New MochiKit.Signal example: draggable
- Added sanity checking to Deferred to ensure that errors happen when chaining
is used incorrectly
- Opera sendXMLHttpRequest fix (sends empty string instead of null by default)
- Fix a bug in MochiKit.Color that incorrectly generated hex colors for
component values smaller than 16/255.
- Fix a bug in MochiKit.Logging that prevented logs from being capped at a
maximum size
- MochiKit.Async.Deferred will now wrap thrown objects that are not instanceof
Error, so that the errback chain is used instead of the callback chain.
- MochiKit.DOM.appendChildNodes and associated functions now append iterables
in the correct order.
- New MochiKit-based SimpleTest test runner as a replacement for Test.Simple
- MochiKit.Base.isNull no longer matches undefined
- example doctypes changed to HTML4
- isDateLike no longer throws error on null
- New MochiKit.Signal module, modeled after the slot/signal mechanism in Qt
- updated elementDimensions to calculate width from offsetWidth instead
of clientWidth
- formContents now works with FORM tags that have a name attribute
- Documentation now uses MochiKit to generate a function index
2006-01-26 v1.2 "the ocho"
- Fixed MochiKit.Color.Color.lighterColorWithLevel
- Added new MochiKit.Base.findIdentical function to find the index of an
element in an Array-like object. Uses === for identity comparison.
- Added new MochiKit.Base.find function to find the index of an element in
an Array-like object. Uses compare for rich comparison.
- MochiKit.Base.bind will accept a string for func, which will be immediately
looked up as self[func].
- MochiKit.DOM.formContents no longer skips empty form elements for Zope
compatibility
- MochiKit.Iter.forEach will now catch StopIteration to break
- New MochiKit.DOM.elementDimensions(element) for determining the width and
height of an element in the document
- MochiKit.DOM's initialization is now compatible with
HTMLUnit + JWebUnit + Rhino
- MochiKit.LoggingPane will now re-use a ``_MochiKit_LoggingPane`` DIV element
currently in the document instead of always creating one.
- MochiKit.Base now has operator.mul
- MochiKit.DOM.formContents correctly handles unchecked checkboxes that have
a custom value attribute
- Added new MochiKit.Color constructors fromComputedStyle and fromText
- MochiKit.DOM.setNodeAttribute should work now
- MochiKit.DOM now has a workaround for an IE bug when setting the style
property to a string
- MochiKit.DOM.createDOM now has workarounds for IE bugs when setting the
name and for properties
- MochiKit.DOM.scrapeText now walks the DOM tree in-order
- MochiKit.LoggingPane now sanitizes the window name to work around IE bug
- MochiKit.DOM now translates usemap to useMap to work around IE bug
- MochiKit.Logging is now resistant to Prototype's dumb Object.prototype hacks
- Added new MochiKit.DOM documentation on element visibility
- New MochiKit.DOM.elementPosition(element[, relativeTo={x: 0, y: 0}])
for determining the position of an element in the document
- Added new MochiKit.DOM createDOMFunc aliases: CANVAS, STRONG
2005-11-14 v1.1
- Fixed a bug in numberFormatter with large numbers
- Massively overhauled documentation
- Fast-path for primitives in MochiKit.Base.compare
- New groupby and groupby_as_array in MochiKit.Iter
- Added iterator factory adapter for objects that implement iterateNext()
- Fixed isoTimestamp to handle timestamps with time zone correctly
- Added new MochiKit.DOM createDOMFunc aliases: SELECT, OPTION, OPTGROUP,
LEGEND, FIELDSET
- New MochiKit.DOM formContents and enhancement to queryString to support it
- Updated view_source example to use dp.SyntaxHighlighter 1.3.0
- MochiKit.LoggingPane now uses named windows based on the URL so that
a given URL will get the same LoggingPane window after a reload
(at the same position, etc.)
- MochiKit.DOM now has currentWindow() and currentDocument() context
variables that are set with withWindow() and withDocument(). These
context variables affect all MochiKit.DOM functionality (getElement,
createDOM, etc.)
- MochiKit.Base.items will now catch and ignore exceptions for properties
that are enumerable but not accessible (e.g. permission denied)
- MochiKit.Async.Deferred's addCallback/addErrback/addBoth
now accept additional arguments that are used to create a partially
applied function. This differs from Twisted in that the callback/errback
result becomes the *last* argument, not the first when this feature
is used.
- MochiKit.Async's doSimpleXMLHttpRequest will now accept additional
arguments which are used to create a GET query string
- Did some refactoring to reduce the footprint of MochiKit by a few
kilobytes
- escapeHTML to longer escapes ' (apos) and now uses
String.replace instead of iterating over every char.
- Added DeferredLock to Async
- Renamed getElementsComputedStyle to computedStyle and moved
it from MochiKit.Visual to MochiKit.DOM
- Moved all color support out of MochiKit.Visual and into MochiKit.Color
- Fixed range() to accept a negative step
- New alias to MochiKit.swapDOM called removeElement
- New MochiKit.DOM.setNodeAttribute(node, attr, value) which sets
an attribute on a node without raising, roughly equivalent to:
updateNodeAttributes(node, {attr: value})
- New MochiKit.DOM.getNodeAttribute(node, attr) which gets the value of
a node's attribute or returns null without raising
- Fixed a potential IE memory leak if using MochiKit.DOM.addToCallStack
directly (addLoadEvent did not leak, since it clears the handler)
2005-10-24 v1.0
- New interpreter example that shows usage of MochiKit.DOM to make
an interactive JavaScript interpreter
- New MochiKit.LoggingPane for use with the MochiKit.Logging
debuggingBookmarklet, with logging_pane example to show its usage
- New mochiregexp example that demonstrates MochiKit.DOM and MochiKit.Async
in order to provide a live regular expression matching tool
- Added advanced number formatting capabilities to MochiKit.Format:
numberFormatter(pattern, placeholder="", locale="default") and
formatLocale(locale="default")
- Added updatetree(self, obj[, ...]) to MochiKit.Base, and changed
MochiKit.DOM's updateNodeAttributes(node, attrs) to use it when appropiate.
- Added new MochiKit.DOM createDOMFunc aliases: BUTTON, TT, PRE
- Added truncToFixed(aNumber, precision) and roundToFixed(aNumber, precision)
to MochiKit.Format
- MochiKit.DateTime can now handle full ISO 8601 timestamps, specifically
isoTimestamp(isoString) will convert them to Date objects, and
toISOTimestamp(date, true) will return an ISO 8601 timestamp in UTC
- Fixed missing errback for sendXMLHttpRequest when the server does not
respond
- Fixed infinite recusion bug when using roundClass("DIV", ...)
- Fixed a bug in MochiKit.Async wait (and callLater) that prevented them
from being cancelled properly
- Workaround in MochiKit.Base bind (and partial) for functions that don't
have an apply method, such as alert
- Reliably return null from the string parsing/manipulation functions if
the input can't be coerced to a string (s + "") or the input makes no sense;
e.g. isoTimestamp(null) and isoTimestamp("") return null
2005-10-08 v0.90
- Fixed ISO compliance with toISODate
- Added missing operator.sub
- Placated Mozilla's strict warnings a bit
- Added JSON serialization and unserialization support to MochiKit.Base:
serializeJSON, evalJSON, registerJSON. This is very similar to the repr
API.
- Fixed a bug in the script loader that failed in some scenarios when a script
tag did not have a "src" attribute (thanks Ian!)
- Added new MochiKit.DOM createDOMFunc aliases: H1, H2, H3, BR, HR, TEXTAREA,
P, FORM
- Use encodeURIComponent / decodeURIComponent for MochiKit.Base urlEncode
and parseQueryString, when available.
2005-08-12 v0.80
- Source highlighting in all examples, moved to a view-source example
- Added some experimental syntax highlighting for the Rounded Corners example,
via the LGPL dp.SyntaxHighlighter 1.2.0 now included in examples/common/lib
- Use an indirect binding for the logger conveniences, so that the global
logger could be replaced by setting MochiKit.Logger.logger to something else
(though an observer is probably a better choice).
- Allow MochiKit.DOM.getElementsByTagAndClassName to take a string for parent,
which will be looked up with getElement
- Fixed bug in MochiKit.Color.fromBackground (was using node.parent instead of
node.parentNode)
- Consider a 304 (NOT_MODIFIED) response from XMLHttpRequest to be success
- Disabled Mozilla map(...) fast-path due to Deer Park compatibility issues
- Possible workaround for Safari issue with swapDOM, where it would get
confused because two elements were in the DOM at the same time with the
same id
- Added missing THEAD convenience function to MochiKit.DOM
- Added lstrip, rstrip, strip to MochiKit.Format
- Added updateNodeAttributes, appendChildNodes, replaceChildNodes to
MochiKit.DOM
- MochiKit.Iter.iextend now has a fast-path for array-like objects
- Added HSV color space support to MochiKit.Visual
- Fixed a bug in the sortable_tables example, it now converts types
correctly
- Fixed a bug where MochiKit.DOM referenced MochiKit.Iter.next from global
scope
2005-08-04 v0.70
- New ajax_tables example, which shows off XMLHttpRequest, ajax, json, and
a little TAL-ish DOM templating attribute language.
- sendXMLHttpRequest and functions that use it (loadJSONDoc, etc.) no longer
ignore requests with status == 0, which seems to happen for cached or local
requests
- Added sendXMLHttpRequest to MochiKit.Async.EXPORT, d'oh.
- Changed scrapeText API to return a string by default. This is API-breaking!
It was dumb to have the default return value be the form you almost never
want. Sorry.
- Added special form to swapDOM(dest, src). If src is null, dest is removed
(where previously you'd likely get a DOM exception).
- Added three new functions to MochiKit.Base for dealing with URL query
strings: urlEncode, queryString, parseQueryString
- MochiKit.DOM.createDOM will now use attr[k] = v for all browsers if the name
starts with "on" (e.g. "onclick"). If v is a string, it will set it to
new Function(v).
- Another workaround for Internet "worst browser ever" Explorer's setAttribute
usage in MochiKit.DOM.createDOM (checked -> defaultChecked).
- Added UL, OL, LI convenience createDOM aliases to MochiKit.DOM
- Packing is now done by Dojo's custom Rhino interpreter, so it's much smaller
now!
2005-07-29 v0.60
- Beefed up the MochiKit.DOM test suite
- Fixed return value for MochiKit.DOM.swapElementClass, could return
false unexpectedly before
- Added an optional "parent" argument to
MochiKit.DOM.getElementsByTagAndClassName
- Added a "packed" version in packed/MochiKit/MochiKit.js
- Changed build script to rewrite the URLs in tests to account for the
JSAN-required reorganization
- MochiKit.Compat to potentially work around IE 5.5 issues
(5.0 still not supported). Test.Simple doesn't seem to work there,
though.
- Several minor documentation corrections
2005-07-27 v0.50
- Initial Release

View File

@@ -1,69 +0,0 @@
MochiKit is dual-licensed software. It is available under the terms of the
MIT License, or the Academic Free License version 2.1. The full text of
each license is included below.
MIT License
===========
Copyright (c) 2005 Bob Ippolito. All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Academic Free License v. 2.1
============================
Copyright (c) 2005 Bob Ippolito. All rights reserved.
This Academic Free License (the "License") applies to any original work of authorship (the "Original Work") whose owner (the "Licensor") has placed the following notice immediately following the copyright notice for the Original Work:
Licensed under the Academic Free License version 2.1
1) Grant of Copyright License. Licensor hereby grants You a world-wide, royalty-free, non-exclusive, perpetual, sublicenseable license to do the following:
a) to reproduce the Original Work in copies;
b) to prepare derivative works ("Derivative Works") based upon the Original Work;
c) to distribute copies of the Original Work and Derivative Works to the public;
d) to perform the Original Work publicly; and
e) to display the Original Work publicly.
2) Grant of Patent License. Licensor hereby grants You a world-wide, royalty-free, non-exclusive, perpetual, sublicenseable license, under patent claims owned or controlled by the Licensor that are embodied in the Original Work as furnished by the Licensor, to make, use, sell and offer for sale the Original Work and Derivative Works.
3) Grant of Source Code License. The term "Source Code" means the preferred form of the Original Work for making modifications to it and all available documentation describing how to modify the Original Work. Licensor hereby agrees to provide a machine-readable copy of the Source Code of the Original Work along with each copy of the Original Work that Licensor distributes. Licensor reserves the right to satisfy this obligation by placing a machine-readable copy of the Source Code in an information repository reasonably calculated to permit inexpensive and convenient access by You for as long as Licensor continues to distribute the Original Work, and by publishing the address of that information repository in a notice immediately following the copyright notice that applies to the Original Work.
4) Exclusions From License Grant. Neither the names of Licensor, nor the names of any contributors to the Original Work, nor any of their trademarks or service marks, may be used to endorse or promote products derived from this Original Work without express prior written permission of the Licensor. Nothing in this License shall be deemed to grant any rights to trademarks, copyrights, patents, trade secrets or any other intellectual property of Licensor except as expressly stated herein. No patent license is granted to make, use, sell or offer to sell embodiments of any patent claims other than the licensed claims defined in Section 2. No right is granted to the trademarks of Licensor even if such marks are included in the Original Work. Nothing in this License shall be interpreted to prohibit Licensor from licensing under different terms from this License any Original Work that Licensor otherwise would have a right to license.
5) This section intentionally omitted.
6) Attribution Rights. You must retain, in the Source Code of any Derivative Works that You create, all copyright, patent or trademark notices from the Source Code of the Original Work, as well as any notices of licensing and any descriptive text identified therein as an "Attribution Notice." You must cause the Source Code for any Derivative Works that You create to carry a prominent Attribution Notice reasonably calculated to inform recipients that You have modified the Original Work.
7) Warranty of Provenance and Disclaimer of Warranty. Licensor warrants that the copyright in and to the Original Work and the patent rights granted herein by Licensor are owned by the Licensor or are sublicensed to You under the terms of this License with the permission of the contributor(s) of those copyrights and patent rights. Except as expressly stated in the immediately proceeding sentence, the Original Work is provided under this License on an "AS IS" BASIS and WITHOUT WARRANTY, either express or implied, including, without limitation, the warranties of NON-INFRINGEMENT, MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY OF THE ORIGINAL WORK IS WITH YOU. This DISCLAIMER OF WARRANTY constitutes an essential part of this License. No license to Original Work is granted hereunder except under this disclaimer.
8) Limitation of Liability. Under no circumstances and under no legal theory, whether in tort (including negligence), contract, or otherwise, shall the Licensor be liable to any person for any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or the use of the Original Work including, without limitation, damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses. This limitation of liability shall not apply to liability for death or personal injury resulting from Licensor's negligence to the extent applicable law prohibits such limitation. Some jurisdictions do not allow the exclusion or limitation of incidental or consequential damages, so this exclusion and limitation may not apply to You.
9) Acceptance and Termination. If You distribute copies of the Original Work or a Derivative Work, You must make a reasonable effort under the circumstances to obtain the express assent of recipients to the terms of this License. Nothing else but this License (or another written agreement between Licensor and You) grants You permission to create Derivative Works based upon the Original Work or to exercise any of the rights granted in Section 1 herein, and any attempt to do so except under the terms of this License (or another written agreement between Licensor and You) is expressly prohibited by U.S. copyright law, the equivalent laws of other countries, and by international treaty. Therefore, by exercising any of the rights granted to You in Section 1 herein, You indicate Your acceptance of this License and all of its terms and conditions.
10) Termination for Patent Action. This License shall terminate automatically and You may no longer exercise any of the rights granted to You by this License as of the date You commence an action, including a cross-claim or counterclaim, against Licensor or any licensee alleging that the Original Work infringes a patent. This termination provision shall not apply for an action alleging patent infringement by combinations of the Original Work with other software or hardware.
11) Jurisdiction, Venue and Governing Law. Any action or suit relating to this License may be brought only in the courts of a jurisdiction wherein the Licensor resides or in which Licensor conducts its primary business, and under the laws of that jurisdiction excluding its conflict-of-law provisions. The application of the United Nations Convention on Contracts for the International Sale of Goods is expressly excluded. Any use of the Original Work outside the scope of this License or after its termination shall be subject to the requirements and penalties of the U.S. Copyright Act, 17 U.S.C. § 101 et seq., the equivalent laws of other countries, and international treaty. This section shall survive the termination of this License.
12) Attorneys Fees. In any action to enforce the terms of this License or seeking damages relating thereto, the prevailing party shall be entitled to recover its costs and expenses, including, without limitation, reasonable attorneys' fees and costs incurred in connection with such action, including any appeal of such action. This section shall survive the termination of this License.
13) Miscellaneous. This License represents the complete agreement concerning the subject matter hereof. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable.
14) Definition of "You" in This License. "You" throughout this License, whether in upper or lower case, means an individual or a legal entity exercising rights under, and complying with all of the terms of, this License. For legal entities, "You" includes any entity that controls, is controlled by, or is under common control with you. For purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
15) Right to Use. You may use the Original Work in all ways not otherwise restricted or conditioned by this License or by law, and Licensor promises not to interfere with or be responsible for such uses by You.
This license is Copyright (C) 2003-2004 Lawrence E. Rosen. All rights reserved. Permission is hereby granted to copy and distribute this license without modification. This license may not be modified without the express written permission of its copyright owner.

View File

@@ -1,115 +0,0 @@
Changes
META.json
MANIFEST This list of files
LICENSE.txt
doc/html/MochiKit/Async.html
doc/html/MochiKit/Base.html
doc/html/MochiKit/Color.html
doc/html/MochiKit/DateTime.html
doc/html/MochiKit/DOM.html
doc/html/MochiKit/Format.html
doc/html/MochiKit/index.html
doc/html/MochiKit/Iter.html
doc/html/MochiKit/Logging.html
doc/html/MochiKit/LoggingPane.html
doc/html/MochiKit/Signal.html
doc/html/MochiKit/VersionHistory.html
doc/html/MochiKit/Visual.html
doc/js/toc.js
doc/rst/MochiKit/Async.rst
doc/rst/MochiKit/Base.rst
doc/rst/MochiKit/Color.rst
doc/rst/MochiKit/DateTime.rst
doc/rst/MochiKit/DOM.rst
doc/rst/MochiKit/Format.rst
doc/rst/MochiKit/index.rst
doc/rst/MochiKit/Iter.rst
doc/rst/MochiKit/Logging.rst
doc/rst/MochiKit/LoggingPane.rst
doc/rst/MochiKit/Signal.rst
doc/rst/MochiKit/VersionHistory.rst
doc/rst/MochiKit/Visual.rst
examples/ajax_tables/ajax_tables.css
examples/ajax_tables/ajax_tables.js
examples/ajax_tables/domains.json
examples/ajax_tables/domains.xml
examples/ajax_tables/index.html
examples/color_wheel/color_wheel.css
examples/color_wheel/color_wheel.js
examples/color_wheel/index.html
examples/draggable/draggable.css
examples/draggable/draggable.js
examples/draggable/index.html
examples/interpreter/index.html
examples/interpreter/interpreter.css
examples/interpreter/interpreter.js
examples/key_events/index.html
examples/key_events/key_events.css
examples/key_events/key_events.js
examples/logging_pane/index.html
examples/logging_pane/logging_pane.css
examples/logging_pane/logging_pane.js
examples/mochiregexp/index.html
examples/mochiregexp/mochiregexp.css
examples/mochiregexp/mochiregexp.js
examples/rounded_corners/index.html
examples/rounded_corners/rounded_corners.css
examples/rounded_corners/rounded_corners.js
examples/sortable_tables/index.html
examples/sortable_tables/sortable_tables.css
examples/sortable_tables/sortable_tables.js
examples/view-source/view-source.css
examples/view-source/view-source.html
examples/view-source/view-source.js
examples/view-source/lib/SyntaxHighlighter/shBrushCSharp.js
examples/view-source/lib/SyntaxHighlighter/shBrushDelphi.js
examples/view-source/lib/SyntaxHighlighter/shBrushJScript.js
examples/view-source/lib/SyntaxHighlighter/shBrushPhp.js
examples/view-source/lib/SyntaxHighlighter/shBrushPython.js
examples/view-source/lib/SyntaxHighlighter/shBrushSql.js
examples/view-source/lib/SyntaxHighlighter/shBrushVb.js
examples/view-source/lib/SyntaxHighlighter/shBrushXml.js
examples/view-source/lib/SyntaxHighlighter/shCore.js
examples/view-source/lib/SyntaxHighlighter/SyntaxHighlighter.css
examples/view-source/lib/SyntaxHighlighter/Tests.html
include/css/documentation.css
include/css/general.css
MochiKit/__package__.js
MochiKit/Async.js
MochiKit/Base.js
MochiKit/Color.js
MochiKit/DateTime.js
MochiKit/DOM.js
MochiKit/Format.js
MochiKit/Iter.js
MochiKit/Logging.js
MochiKit/LoggingPane.js
MochiKit/MochiKit.js
MochiKit/MockDOM.js
MochiKit/Signal.js
MochiKit/Test.js
MochiKit/Visual.js
packed/MochiKit/__package__.js
packed/MochiKit/MochiKit.js
tests/index.html
tests/test_Base.js
tests/test_Color.js
tests/test_DateTime.js
tests/test_Format.js
tests/test_Iter.js
tests/test_Logging.js
tests/test_MochiKit-Async.html
tests/test_MochiKit-Base.html
tests/test_MochiKit-Color.html
tests/test_MochiKit-DateTime.html
tests/test_MochiKit-DOM.html
tests/test_MochiKit-Format.html
tests/test_MochiKit-Iter.html
tests/test_MochiKit-JSAN.html
tests/test_MochiKit-Logging.html
tests/test_MochiKit-MochiKit.html
tests/test_MochiKit-Signal.html
tests/test_Signal.js
tests/SimpleTest/SimpleTest.js
tests/SimpleTest/test.css
tests/SimpleTest/TestRunner.js

View File

@@ -1,17 +0,0 @@
{
"recommends": {
"JSAN": "0.10"
},
"name": "MochiKit",
"license": "mit",
"author": [
"Bob Ippolito <bob@redivi.com>"
],
"abstract": "Python-inspired JavaScript kit",
"generated_by": "MochiKit's build script",
"build_requires": {
"Test.Simple": "0.11"
},
"version": "1.3.1",
"provides": {}
}

View File

@@ -1,606 +0,0 @@
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
<title>MochiKit.Async - manage asynchronous tasks</title>
<link rel="stylesheet" href="../../../include/css/documentation.css" type="text/css" />
<script type="text/javascript" src="../../../packed/lib/MochiKit/MochiKit.js"></script>
<script type="text/javascript" src="../../js/toc.js"></script>
</head>
<body>
<div class="document">
<div class="section">
<h1><a id="name" name="name">Name</a></h1>
<p>MochiKit.Async - manage asynchronous tasks</p>
</div>
<div class="section">
<h1><a id="synopsis" name="synopsis">Synopsis</a></h1>
<pre class="literal-block">
var url = &quot;/src/b/bo/bob/MochiKit.Async/META.json&quot;;
/*
META.json looks something like this:
{&quot;name&quot;: &quot;MochiKit&quot;, &quot;version&quot;: &quot;0.5&quot;}
*/
var d = loadJSONDoc(url);
var gotMetadata = function (meta) {
if (MochiKit.Async.VERSION == meta.version) {
alert(&quot;You have the newest MochiKit.Async!&quot;);
} else {
alert(&quot;MochiKit.Async &quot;
+ meta.version
+ &quot; is available, upgrade!&quot;);
}
};
var metadataFetchFailed = function (err) {
alert(&quot;The metadata for MochiKit.Async could not be fetched :(&quot;);
};
d.addCallbacks(gotMetadata, metadataFetchFailed);
</pre>
</div>
<div class="section">
<h1><a id="description" name="description">Description</a></h1>
<p>MochiKit.Async provides facilities to manage asynchronous
(as in AJAX <a class="footnote-reference" href="#id7" id="id1" name="id1">[1]</a>) tasks. The model for asynchronous computation
used in this module is heavily inspired by Twisted <a class="footnote-reference" href="#id8" id="id2" name="id2">[2]</a>.</p>
</div>
<div class="section">
<h1><a id="dependencies" name="dependencies">Dependencies</a></h1>
<ul class="simple">
<li><a class="mochiref reference" href="Base.html">MochiKit.Base</a></li>
</ul>
</div>
<div class="section">
<h1><a id="overview" name="overview">Overview</a></h1>
<div class="section">
<h2><a id="deferred" name="deferred">Deferred</a></h2>
<p>The Deferred constructor encapsulates a single value that
is not available yet. The most important example of this
in the context of a web browser would be an <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt>
to a server. The importance of the Deferred is that it
allows a consistent API to be exposed for all asynchronous
computations that occur exactly once.</p>
<p>The producer of the Deferred is responsible for doing all
of the complicated work behind the scenes. This often
means waiting for a timer to fire, or waiting for an event
(e.g. <tt class="docutils literal"><span class="pre">onreadystatechange</span></tt> of <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt>).
It could also be coordinating several events (e.g.
<tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt> with a timeout, or several Deferreds
(e.g. fetching a set of XML documents that should be
processed at the same time).</p>
<p>Since these sorts of tasks do not respond immediately, the
producer of the Deferred does the following steps before
returning to the consumer:</p>
<ol class="arabic simple">
<li>Create a <tt class="docutils literal"><span class="pre">new</span></tt> <a class="mochiref reference" href="#fn-deferred">Deferred();</a> object and keep a reference
to it, because it will be needed later when the value is
ready.</li>
<li>Setup the conditions to create the value requested (e.g.
create a new <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt>, set its
<tt class="docutils literal"><span class="pre">onreadystatechange</span></tt>).</li>
<li>Return the <a class="mochiref reference" href="#fn-deferred">Deferred</a> object.</li>
</ol>
<p>Since the value is not yet ready, the consumer attaches
a function to the Deferred that will be called when the
value is ready. This is not unlike <tt class="docutils literal"><span class="pre">setTimeout</span></tt>, or
other similar facilities you may already be familiar with.
The consumer can also attach an &quot;errback&quot; to the
<a class="mochiref reference" href="#fn-deferred">Deferred</a>, which is a callback for error handling.</p>
<p>When the value is ready, the producer simply calls
<tt class="docutils literal"><span class="pre">myDeferred.callback(theValue)</span></tt>. If an error occurred,
it should call <tt class="docutils literal"><span class="pre">myDeferred.errback(theValue)</span></tt> instead.
As soon as this happens, the callback that the consumer
attached to the <a class="mochiref reference" href="#fn-deferred">Deferred</a> is called with <tt class="docutils literal"><span class="pre">theValue</span></tt>
as the only argument.</p>
<p>There are quite a few additional &quot;advanced&quot; features
baked into <a class="mochiref reference" href="#fn-deferred">Deferred</a>, such as cancellation and
callback chains, so take a look at the API
reference if you would like to know more!</p>
</div>
</div>
<div class="section">
<h1><a id="api-reference" name="api-reference">API Reference</a></h1>
<div class="section">
<h2><a id="errors" name="errors">Errors</a></h2>
<p>
<a name="fn-alreadycallederror"></a>
<a class="mochidef reference" href="#fn-alreadycallederror">AlreadyCalledError</a>:</p>
<blockquote>
Thrown by a <a class="mochiref reference" href="#fn-deferred">Deferred</a> if <tt class="docutils literal"><span class="pre">.callback</span></tt> or
<tt class="docutils literal"><span class="pre">.errback</span></tt> are called more than once.</blockquote>
<p>
<a name="fn-browsercomplianceerror"></a>
<a class="mochidef reference" href="#fn-browsercomplianceerror">BrowserComplianceError</a>:</p>
<blockquote>
Thrown when the JavaScript runtime is not capable of performing
the given function. Currently, this happens if the browser
does not support <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt>.</blockquote>
<p>
<a name="fn-cancellederror"></a>
<a class="mochidef reference" href="#fn-cancellederror">CancelledError</a>:</p>
<blockquote>
Thrown by a <a class="mochiref reference" href="#fn-deferred">Deferred</a> when it is cancelled,
unless a canceller is present and throws something else.</blockquote>
<p>
<a name="fn-genericerror"></a>
<a class="mochidef reference" href="#fn-genericerror">GenericError</a>:</p>
<blockquote>
Results passed to <tt class="docutils literal"><span class="pre">.fail</span></tt> or <tt class="docutils literal"><span class="pre">.errback</span></tt> of a <a class="mochiref reference" href="#fn-deferred">Deferred</a>
are wrapped by this <tt class="docutils literal"><span class="pre">Error</span></tt> if <tt class="docutils literal"><span class="pre">!(result</span> <span class="pre">instanceof</span> <span class="pre">Error)</span></tt>.</blockquote>
<p>
<a name="fn-xmlhttprequesterror"></a>
<a class="mochidef reference" href="#fn-xmlhttprequesterror">XMLHttpRequestError</a>:</p>
<blockquote>
Thrown when an <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt> does not complete successfully
for any reason. The <tt class="docutils literal"><span class="pre">req</span></tt> property of the error is the failed
<tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt> object, and for convenience the <tt class="docutils literal"><span class="pre">number</span></tt>
property corresponds to <tt class="docutils literal"><span class="pre">req.status</span></tt>.</blockquote>
</div>
<div class="section">
<h2><a id="constructors" name="constructors">Constructors</a></h2>
<p>
<a name="fn-deferred"></a>
<a class="mochidef reference" href="#fn-deferred">Deferred()</a>:</p>
<blockquote>
Encapsulates a sequence of callbacks in response to a value that
may not yet be available. This is modeled after the Deferred class
from Twisted <a class="footnote-reference" href="#id9" id="id3" name="id3">[3]</a>.</blockquote>
<blockquote>
<p>Why do we want this? JavaScript has no threads, and even if it did,
threads are hard. Deferreds are a way of abstracting non-blocking
events, such as the final response to an <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt>.</p>
<p>The sequence of callbacks is internally represented as a list
of 2-tuples containing the callback/errback pair. For example,
the following call sequence:</p>
<pre class="literal-block">
var d = new Deferred();
d.addCallback(myCallback);
d.addErrback(myErrback);
d.addBoth(myBoth);
d.addCallbacks(myCallback, myErrback);
</pre>
<p>is translated into a <a class="mochiref reference" href="#fn-deferred">Deferred</a> with the following internal
representation:</p>
<pre class="literal-block">
[
[myCallback, null],
[null, myErrback],
[myBoth, myBoth],
[myCallback, myErrback]
]
</pre>
<p>The <a class="mochiref reference" href="#fn-deferred">Deferred</a> also keeps track of its current status (fired).
Its status may be one of the following three values:</p>
<blockquote>
<table border="1" class="docutils">
<colgroup>
<col width="14%" />
<col width="86%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">Value</th>
<th class="head">Condition</th>
</tr>
</thead>
<tbody valign="top">
<tr><td>-1</td>
<td>no value yet (initial condition)</td>
</tr>
<tr><td>0</td>
<td>success</td>
</tr>
<tr><td>1</td>
<td>error</td>
</tr>
</tbody>
</table>
</blockquote>
<p>A <a class="mochiref reference" href="#fn-deferred">Deferred</a> will be in the error state if one of the following
conditions are met:</p>
<ol class="arabic simple">
<li>The result given to callback or errback is &quot;<tt class="docutils literal"><span class="pre">instanceof</span> <span class="pre">Error</span></tt>&quot;</li>
<li>The callback or errback threw while executing. If the thrown object
is not <tt class="docutils literal"><span class="pre">instanceof</span> <span class="pre">Error</span></tt>, it will be wrapped with
<a class="mochiref reference" href="#fn-genericerror">GenericError</a>.</li>
</ol>
<p>Otherwise, the <a class="mochiref reference" href="#fn-deferred">Deferred</a> will be in the success state. The state
of the <a class="mochiref reference" href="#fn-deferred">Deferred</a> determines the next element in the callback
sequence to run.</p>
<p>When a callback or errback occurs with the example deferred chain, something
equivalent to the following will happen (imagine that exceptions are caught
and returned as-is):</p>
<pre class="literal-block">
// d.callback(result) or d.errback(result)
if (!(result instanceof Error)) {
result = myCallback(result);
}
if (result instanceof Error) {
result = myErrback(result);
}
result = myBoth(result);
if (result instanceof Error) {
result = myErrback(result);
} else {
result = myCallback(result);
}
</pre>
<p>The result is then stored away in case another step is added to the
callback sequence. Since the <a class="mochiref reference" href="#fn-deferred">Deferred</a> already has a value
available, any new callbacks added will be called immediately.</p>
<p>There are two other &quot;advanced&quot; details about this implementation that are
useful:</p>
<p>Callbacks are allowed to return <a class="mochiref reference" href="#fn-deferred">Deferred</a> instances,
so you can build complicated sequences of events with (relative) ease.</p>
<p>The creator of the <a class="mochiref reference" href="#fn-deferred">Deferred</a> may specify a canceller. The
canceller is a function that will be called if
<a class="mochiref reference" href="#fn-deferred.prototype.cancel">Deferred.prototype.cancel</a> is called before the
<a class="mochiref reference" href="#fn-deferred">Deferred</a> fires. You can use this to allow an
<tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt> to be cleanly cancelled, for example. Note that
cancel will fire the <a class="mochiref reference" href="#fn-deferred">Deferred</a> with a
<a class="mochiref reference" href="#fn-cancellederror">CancelledError</a> (unless your canceller throws or returns
a different <tt class="docutils literal"><span class="pre">Error</span></tt>), so errbacks should be prepared to handle that
<tt class="docutils literal"><span class="pre">Error</span></tt> gracefully for cancellable <a class="mochiref reference" href="#fn-deferred">Deferred</a> instances.</p>
</blockquote>
<p>
<a name="fn-deferred.prototype.addboth"></a>
<a class="mochidef reference" href="#fn-deferred.prototype.addboth">Deferred.prototype.addBoth(func)</a>:</p>
<blockquote>
<p>Add the same function as both a callback and an errback as the
next element on the callback sequence. This is useful for code
that you want to guarantee to run, e.g. a finalizer.</p>
<p>If additional arguments are given, then <tt class="docutils literal"><span class="pre">func</span></tt> will be replaced
with <a class="mochiref reference" href="Base.html#fn-partial">MochiKit.Base.partial.apply(null, arguments)</a>. This
differs from <a class="reference" href="http://twistedmatrix.com/">Twisted</a>, because the result of the callback or
errback will be the <em>last</em> argument passed to <tt class="docutils literal"><span class="pre">func</span></tt>.</p>
<p>If <tt class="docutils literal"><span class="pre">func</span></tt> returns a <a class="mochiref reference" href="#fn-deferred">Deferred</a>, then it will be chained
(its value or error will be passed to the next callback). Note that
once the returned <tt class="docutils literal"><span class="pre">Deferred</span></tt> is chained, it can no longer accept new
callbacks.</p>
</blockquote>
<p>
<a name="fn-deferred.prototype.addcallback"></a>
<a class="mochidef reference" href="#fn-deferred.prototype.addcallback">Deferred.prototype.addCallback(func[, ...])</a>:</p>
<blockquote>
<p>Add a single callback to the end of the callback sequence.</p>
<p>If additional arguments are given, then <tt class="docutils literal"><span class="pre">func</span></tt> will be replaced
with <a class="mochiref reference" href="Base.html#fn-partial">MochiKit.Base.partial.apply(null, arguments)</a>. This
differs from <a class="reference" href="http://twistedmatrix.com/">Twisted</a>, because the result of the callback will
be the <em>last</em> argument passed to <tt class="docutils literal"><span class="pre">func</span></tt>.</p>
<p>If <tt class="docutils literal"><span class="pre">func</span></tt> returns a <a class="mochiref reference" href="#fn-deferred">Deferred</a>, then it will be chained
(its value or error will be passed to the next callback). Note that
once the returned <tt class="docutils literal"><span class="pre">Deferred</span></tt> is chained, it can no longer accept new
callbacks.</p>
</blockquote>
<p>
<a name="fn-deferred.prototype.addcallbacks"></a>
<a class="mochidef reference" href="#fn-deferred.prototype.addcallbacks">Deferred.prototype.addCallbacks(callback, errback)</a>:</p>
<blockquote>
<p>Add separate callback and errback to the end of the callback
sequence. Either callback or errback may be <tt class="docutils literal"><span class="pre">null</span></tt>,
but not both.</p>
<p>If <tt class="docutils literal"><span class="pre">callback</span></tt> or <tt class="docutils literal"><span class="pre">errback</span></tt> returns a <a class="mochiref reference" href="#fn-deferred">Deferred</a>,
then it will be chained (its value or error will be passed to the
next callback). Note that once the returned <tt class="docutils literal"><span class="pre">Deferred</span></tt> is chained,
it can no longer accept new callbacks.</p>
</blockquote>
<p>
<a name="fn-deferred.prototype.adderrback"></a>
<a class="mochidef reference" href="#fn-deferred.prototype.adderrback">Deferred.prototype.addErrback(func)</a>:</p>
<blockquote>
<p>Add a single errback to the end of the callback sequence.</p>
<p>If additional arguments are given, then <tt class="docutils literal"><span class="pre">func</span></tt> will be replaced
with <a class="mochiref reference" href="Base.html#fn-partial">MochiKit.Base.partial.apply(null, arguments)</a>. This
differs from <a class="reference" href="http://twistedmatrix.com/">Twisted</a>, because the result of the errback will
be the <em>last</em> argument passed to <tt class="docutils literal"><span class="pre">func</span></tt>.</p>
<p>If <tt class="docutils literal"><span class="pre">func</span></tt> returns a <a class="mochiref reference" href="#fn-deferred">Deferred</a>, then it will be chained
(its value or error will be passed to the next callback). Note that
once the returned <tt class="docutils literal"><span class="pre">Deferred</span></tt> is chained, it can no longer accept new
callbacks.</p>
</blockquote>
<p>
<a name="fn-deferred.prototype.callback"></a>
<a class="mochidef reference" href="#fn-deferred.prototype.callback">Deferred.prototype.callback([result])</a>:</p>
<blockquote>
<p>Begin the callback sequence with a non-<tt class="docutils literal"><span class="pre">Error</span></tt> result. Result
may be any value except for a <a class="mochiref reference" href="#fn-deferred">Deferred</a>.</p>
<p>Either <tt class="docutils literal"><span class="pre">.callback</span></tt> or <tt class="docutils literal"><span class="pre">.errback</span></tt> should
be called exactly once on a <a class="mochiref reference" href="#fn-deferred">Deferred</a>.</p>
</blockquote>
<p>
<a name="fn-deferred.prototype.cancel"></a>
<a class="mochidef reference" href="#fn-deferred.prototype.cancel">Deferred.prototype.cancel()</a>:</p>
<blockquote>
<p>Cancels a <a class="mochiref reference" href="#fn-deferred">Deferred</a> that has not yet received a value,
or is waiting on another <a class="mochiref reference" href="#fn-deferred">Deferred</a> as its value.</p>
<p>If a canceller is defined, the canceller is called.
If the canceller did not return an <tt class="docutils literal"><span class="pre">Error</span></tt>, or there
was no canceller, then the errback chain is started
with <a class="mochiref reference" href="#fn-cancellederror">CancelledError</a>.</p>
</blockquote>
<p>
<a name="fn-deferred.prototype.errback"></a>
<a class="mochidef reference" href="#fn-deferred.prototype.errback">Deferred.prototype.errback([result])</a>:</p>
<blockquote>
<p>Begin the callback sequence with an error result.
Result may be any value except for a <a class="mochiref reference" href="#fn-deferred">Deferred</a>,
but if <tt class="docutils literal"><span class="pre">!(result</span> <span class="pre">instanceof</span> <span class="pre">Error)</span></tt>, it will be wrapped
with <a class="mochiref reference" href="#fn-genericerror">GenericError</a>.</p>
<p>Either <tt class="docutils literal"><span class="pre">.callback</span></tt> or <tt class="docutils literal"><span class="pre">.errback</span></tt> should
be called exactly once on a
<a name="fn-deferred"></a>
<a class="mochidef reference" href="#fn-deferred">Deferred</a>.</p>
</blockquote>
<p>
<a name="fn-deferredlock"></a>
<a class="mochidef reference" href="#fn-deferredlock">DeferredLock()</a>:</p>
<blockquote>
<p>A lock for asynchronous systems.</p>
<p>The <tt class="docutils literal"><span class="pre">locked</span></tt> property of a <a class="mochiref reference" href="#fn-deferredlock">DeferredLock</a> will be <tt class="docutils literal"><span class="pre">true</span></tt> if
it locked, <tt class="docutils literal"><span class="pre">false</span></tt> otherwise. Do not change this property.</p>
</blockquote>
<p>
<a name="fn-deferredlock.prototype.acquire"></a>
<a class="mochidef reference" href="#fn-deferredlock.prototype.acquire">DeferredLock.prototype.acquire()</a>:</p>
<blockquote>
Attempt to acquire the lock. Returns a <a class="mochiref reference" href="#fn-deferred">Deferred</a> that fires on
lock acquisition with the <a class="mochiref reference" href="#fn-deferredlock">DeferredLock</a> as the value.
If the lock is locked, then the <a class="mochiref reference" href="#fn-deferred">Deferred</a> goes into a waiting
list.</blockquote>
<p>
<a name="fn-deferredlock.prototype.release"></a>
<a class="mochidef reference" href="#fn-deferredlock.prototype.release">DeferredLock.prototype.release()</a>:</p>
<blockquote>
Release the lock. If there is a waiting list, then the first
<a class="mochiref reference" href="#fn-deferred">Deferred</a> in that waiting list will be called back.</blockquote>
<p>
<a name="fn-deferredlist"></a>
<a class="mochidef reference" href="#fn-deferredlist">DeferredList(list, [fireOnOneCallback, fireOnOneErrback, consumeErrors, canceller])</a>:</p>
<blockquote>
<p>Combine a list of <a class="mochiref reference" href="#fn-deferred">Deferred</a> into one. Track the callbacks and
return a list of (success, result) tuples, 'success' being a boolean
indicating whether result is a normal result or an error.</p>
<p>Once created, you have access to all <a class="mochiref reference" href="#fn-deferred">Deferred</a> methods, like
addCallback, addErrback, addBoth. The behaviour can be changed by the
following options:</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">fireOnOneCallback</span></tt>:</dt>
<dd>Flag for launching the callback once the first Deferred of the list
has returned.</dd>
<dt><tt class="docutils literal"><span class="pre">fireOnOneErrback</span></tt>:</dt>
<dd>Flag for calling the errback at the first error of a Deferred.</dd>
<dt><tt class="docutils literal"><span class="pre">consumeErrors</span></tt>:</dt>
<dd>Flag indicating that any errors raised in the Deferreds should be
consumed by the DeferredList.</dd>
</dl>
<p>Example:</p>
<pre class="literal-block">
// We need to fetch data from 2 different urls
var d1 = loadJSONDoc(url1);
var d2 = loadJSONDoc(url2);
var l1 = new DeferredList([d1, d2], false, false, true);
l1.addCallback(function (resultList) {
MochiKit.Base.map(function (result) {
if (result[0]) {
alert(&quot;Data is here: &quot; + result[1]);
} else {
alert(&quot;Got an error: &quot; + result[1]);
}
}, resultList);
});
</pre>
</blockquote>
</div>
<div class="section">
<h2><a id="functions" name="functions">Functions</a></h2>
<p>
<a name="fn-calllater"></a>
<a class="mochidef reference" href="#fn-calllater">callLater(seconds, func[, args...])</a>:</p>
<blockquote>
<p>Call <tt class="docutils literal"><span class="pre">func(args...)</span></tt> after at least <tt class="docutils literal"><span class="pre">seconds</span></tt> seconds have elapsed.
This is a convenience method for:</p>
<pre class="literal-block">
func = partial.apply(extend(null, arguments, 1));
return wait(seconds).addCallback(function (res) { return func() });
</pre>
<p>Returns a cancellable <a class="mochiref reference" href="#fn-deferred">Deferred</a>.</p>
</blockquote>
<p>
<a name="fn-dosimplexmlhttprequest"></a>
<a class="mochidef reference" href="#fn-dosimplexmlhttprequest">doSimpleXMLHttpRequest(url[, queryArguments...])</a>:</p>
<blockquote>
<p>Perform a simple <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt> and wrap it with a
<a class="mochiref reference" href="#fn-deferred">Deferred</a> that may be cancelled.</p>
<p>Note that currently, only <tt class="docutils literal"><span class="pre">200</span></tt> (OK) and <tt class="docutils literal"><span class="pre">304</span></tt>
(NOT_MODIFIED) are considered success codes at this time, other
status codes will result in an errback with an <tt class="docutils literal"><span class="pre">XMLHttpRequestError</span></tt>.</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">url</span></tt>:</dt>
<dd>The URL to GET</dd>
<dt><tt class="docutils literal"><span class="pre">queryArguments</span></tt>:</dt>
<dd><p class="first">If this function is called with more than one argument, a <tt class="docutils literal"><span class="pre">&quot;?&quot;</span></tt>
and the result of <a class="mochiref reference" href="Base.html#fn-querystring">MochiKit.Base.queryString</a> with
the rest of the arguments are appended to the URL.</p>
<p>For example, this will do a GET request to the URL
<tt class="docutils literal"><span class="pre">http://example.com?bar=baz</span></tt>:</p>
<pre class="last literal-block">
doSimpleXMLHttpRequest(&quot;http://example.com&quot;, {bar: &quot;baz&quot;});
</pre>
</dd>
<dt><em>returns</em>:</dt>
<dd><a class="mochiref reference" href="#fn-deferred">Deferred</a> that will callback with the <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt>
instance on success</dd>
</dl>
</blockquote>
<p>
<a name="fn-evaljsonrequest"></a>
<a class="mochidef reference" href="#fn-evaljsonrequest">evalJSONRequest(req)</a>:</p>
<blockquote>
<p>Evaluate a JSON <a class="footnote-reference" href="#id10" id="id4" name="id4">[4]</a> <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt></p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">req</span></tt>:</dt>
<dd>The request whose <tt class="docutils literal"><span class="pre">.responseText</span></tt> property is to be evaluated</dd>
<dt><em>returns</em>:</dt>
<dd>A JavaScript object</dd>
</dl>
</blockquote>
<p>
<a name="fn-fail"></a>
<a class="mochidef reference" href="#fn-fail">fail([result])</a>:</p>
<blockquote>
<p>Return a <a class="mochiref reference" href="#fn-deferred">Deferred</a> that has already had <tt class="docutils literal"><span class="pre">.errback(result)</span></tt>
called.</p>
<p>See <tt class="docutils literal"><span class="pre">succeed</span></tt> documentation for rationale.</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">result</span></tt>:</dt>
<dd>The result to give to <a class="mochiref reference" href="#fn-deferred.prototype.errback">Deferred.prototype.errback(result)</a>.</dd>
<dt><em>returns</em>:</dt>
<dd>A <tt class="docutils literal"><span class="pre">new</span></tt> <a class="mochiref reference" href="#fn-deferred">Deferred()</a></dd>
</dl>
</blockquote>
<p>
<a name="fn-gatherresults"></a>
<a class="mochidef reference" href="#fn-gatherresults">gatherResults(deferreds)</a>:</p>
<blockquote>
A convenience function that returns a <a class="mochiref reference" href="#fn-deferredlist">DeferredList</a>
from the given <tt class="docutils literal"><span class="pre">Array</span></tt> of <a class="mochiref reference" href="#fn-deferred">Deferred</a> instances
that will callback with an <tt class="docutils literal"><span class="pre">Array</span></tt> of just results when
they're available, or errback on the first array.</blockquote>
<p>
<a name="fn-getxmlhttprequest"></a>
<a class="mochidef reference" href="#fn-getxmlhttprequest">getXMLHttpRequest()</a>:</p>
<blockquote>
<p>Return an <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt> compliant object for the current
platform.</p>
<p>In order of preference:</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">new</span> <span class="pre">XMLHttpRequest()</span></tt></li>
<li><tt class="docutils literal"><span class="pre">new</span> <span class="pre">ActiveXObject('Msxml2.XMLHTTP')</span></tt></li>
<li><tt class="docutils literal"><span class="pre">new</span> <span class="pre">ActiveXObject('Microsoft.XMLHTTP')</span></tt></li>
<li><tt class="docutils literal"><span class="pre">new</span> <span class="pre">ActiveXObject('Msxml2.XMLHTTP.4.0')</span></tt></li>
</ul>
</blockquote>
<p>
<a name="fn-maybedeferred"></a>
<a class="mochidef reference" href="#fn-maybedeferred">maybeDeferred(func[, argument...])</a>:</p>
<blockquote>
<p>Call a <tt class="docutils literal"><span class="pre">func</span></tt> with the given arguments and ensure the result is a
<a class="mochiref reference" href="#fn-deferred">Deferred</a>.</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">func</span></tt>:</dt>
<dd>The function to call.</dd>
<dt><em>returns</em>:</dt>
<dd>A new <a class="mochiref reference" href="#fn-deferred">Deferred</a> based on the call to <tt class="docutils literal"><span class="pre">func</span></tt>. If <tt class="docutils literal"><span class="pre">func</span></tt>
does not naturally return a <a class="mochiref reference" href="#fn-deferred">Deferred</a>, its result or error
value will be wrapped by one.</dd>
</dl>
</blockquote>
<p>
<a name="fn-loadjsondoc"></a>
<a class="mochidef reference" href="#fn-loadjsondoc">loadJSONDoc(url)</a>:</p>
<blockquote>
<p>Do a simple <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt> to a URL and get the response
as a JSON <a class="footnote-reference" href="#id10" id="id5" name="id5">[4]</a> document.</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">url</span></tt>:</dt>
<dd>The URL to GET</dd>
<dt><em>returns</em>:</dt>
<dd><a class="mochiref reference" href="#fn-deferred">Deferred</a> that will callback with the evaluated JSON <a class="footnote-reference" href="#id10" id="id6" name="id6">[4]</a>
response upon successful <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt></dd>
</dl>
</blockquote>
<p>
<a name="fn-sendxmlhttprequest"></a>
<a class="mochidef reference" href="#fn-sendxmlhttprequest">sendXMLHttpRequest(req[, sendContent])</a>:</p>
<blockquote>
<p>Set an <tt class="docutils literal"><span class="pre">onreadystatechange</span></tt> handler on an <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt> object
and send it off. Will return a cancellable <a class="mochiref reference" href="#fn-deferred">Deferred</a> that will
callback on success.</p>
<p>Note that currently, only <tt class="docutils literal"><span class="pre">200</span></tt> (OK) and <tt class="docutils literal"><span class="pre">304</span></tt>
(NOT_MODIFIED) are considered success codes at this time, other
status codes will result in an errback with an <tt class="docutils literal"><span class="pre">XMLHttpRequestError</span></tt>.</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">req</span></tt>:</dt>
<dd>An preconfigured <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt> object (open has been called).</dd>
<dt><tt class="docutils literal"><span class="pre">sendContent</span></tt>:</dt>
<dd>Optional string or DOM content to send over the <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt>.</dd>
<dt><em>returns</em>:</dt>
<dd><a class="mochiref reference" href="#fn-deferred">Deferred</a> that will callback with the <tt class="docutils literal"><span class="pre">XMLHttpRequest</span></tt>
instance on success.</dd>
</dl>
</blockquote>
<p>
<a name="fn-succeed"></a>
<a class="mochidef reference" href="#fn-succeed">succeed([result])</a>:</p>
<blockquote>
<p>Return a <a class="mochiref reference" href="#fn-deferred">Deferred</a> that has already had <tt class="docutils literal"><span class="pre">.callback(result)</span></tt>
called.</p>
<p>This is useful when you're writing synchronous code to an asynchronous
interface: i.e., some code is calling you expecting a <a class="mochiref reference" href="#fn-deferred">Deferred</a>
result, but you don't actually need to do anything asynchronous. Just
return <tt class="docutils literal"><span class="pre">succeed(theResult)</span></tt>.</p>
<p>See <tt class="docutils literal"><span class="pre">fail</span></tt> for a version of this function that uses a failing
<a class="mochiref reference" href="#fn-deferred">Deferred</a> rather than a successful one.</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">result</span></tt>:</dt>
<dd>The result to give to <a class="mochiref reference" href="#fn-deferred.prototype.callback">Deferred.prototype.callback(result)</a></dd>
<dt><em>returns</em>:</dt>
<dd>a <tt class="docutils literal"><span class="pre">new</span></tt> <a class="mochiref reference" href="#fn-deferred">Deferred</a></dd>
</dl>
</blockquote>
<p>
<a name="fn-wait"></a>
<a class="mochidef reference" href="#fn-wait">wait(seconds[, res])</a>:</p>
<blockquote>
Return a new cancellable <a class="mochiref reference" href="#fn-deferred">Deferred</a> that will <tt class="docutils literal"><span class="pre">.callback(res)</span></tt>
after at least <tt class="docutils literal"><span class="pre">seconds</span></tt> seconds have elapsed.</blockquote>
</div>
</div>
<div class="section">
<h1><a id="see-also" name="see-also">See Also</a></h1>
<table class="docutils footnote" frame="void" id="id7" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id1" name="id7">[1]</a></td><td>AJAX, Asynchronous JavaScript and XML: <a class="reference" href="http://en.wikipedia.org/wiki/AJAX">http://en.wikipedia.org/wiki/AJAX</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id8" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id2" name="id8">[2]</a></td><td>Twisted, an event-driven networking framework written in Python: <a class="reference" href="http://twistedmatrix.com/">http://twistedmatrix.com/</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id9" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id3" name="id9">[3]</a></td><td>Twisted Deferred Reference: <a class="reference" href="http://twistedmatrix.com/projects/core/documentation/howto/defer.html">http://twistedmatrix.com/projects/core/documentation/howto/defer.html</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id10" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a name="id10">[4]</a></td><td><em>(<a class="fn-backref" href="#id4">1</a>, <a class="fn-backref" href="#id5">2</a>, <a class="fn-backref" href="#id6">3</a>)</em> JSON, JavaScript Object Notation: <a class="reference" href="http://json.org/">http://json.org/</a></td></tr>
</tbody>
</table>
</div>
<div class="section">
<h1><a id="authors" name="authors">Authors</a></h1>
<ul class="simple">
<li>Bob Ippolito &lt;<a class="reference" href="mailto:bob&#64;redivi.com">bob&#64;redivi.com</a>&gt;</li>
</ul>
</div>
<div class="section">
<h1><a id="copyright" name="copyright">Copyright</a></h1>
<p>Copyright 2005 Bob Ippolito &lt;<a class="reference" href="mailto:bob&#64;redivi.com">bob&#64;redivi.com</a>&gt;. This program is dual-licensed
free software; you can redistribute it and/or modify it under the terms of the
<a class="reference" href="http://www.opensource.org/licenses/mit-license.php">MIT License</a> or the <a class="reference" href="http://www.opensource.org/licenses/afl-2.1.php">Academic Free License v2.1</a>.</p>
</div>
</div>
</body>
</html>

View File

@@ -1,509 +0,0 @@
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
<title>MochiKit.Color - color abstraction with CSS3 support</title>
<link rel="stylesheet" href="../../../include/css/documentation.css" type="text/css" />
<script type="text/javascript" src="../../../packed/lib/MochiKit/MochiKit.js"></script>
<script type="text/javascript" src="../../js/toc.js"></script>
</head>
<body>
<div class="document">
<div class="section">
<h1><a id="name" name="name">Name</a></h1>
<p>MochiKit.Color - color abstraction with CSS3 support</p>
</div>
<div class="section">
<h1><a id="synopsis" name="synopsis">Synopsis</a></h1>
<pre class="literal-block">
// RGB color expressions are supported
assert(
objEqual(Color.whiteColor(), Color.fromString(&quot;rgb(255,100%, 255)&quot;))
);
// So is instantiating directly from HSL or RGB values.
// Note that fromRGB and fromHSL take numbers between 0.0 and 1.0!
assert( objEqual(Color.fromRGB(1.0, 1.0, 1.0), Color.fromHSL(0.0, 0.0, 1.0) );
// Or even SVG color keyword names, as per CSS3!
assert( Color.fromString(&quot;aquamarine&quot;), &quot;#7fffd4&quot; );
// NSColor-like colors built in
assert( Color.whiteColor().toHexString() == &quot;#ffffff&quot; );
</pre>
</div>
<div class="section">
<h1><a id="description" name="description">Description</a></h1>
<p>MochiKit.Color is an abstraction for handling colors and strings that
represent colors.</p>
</div>
<div class="section">
<h1><a id="dependencies" name="dependencies">Dependencies</a></h1>
<ul class="simple">
<li><a class="mochiref reference" href="Base.html">MochiKit.Base</a></li>
</ul>
</div>
<div class="section">
<h1><a id="overview" name="overview">Overview</a></h1>
<p>MochiKit.Color provides an abstraction of RGB, HSL and HSV colors with alpha.
It supports parsing and generating of CSS3 colors, and has a full CSS3 (SVG)
color table.</p>
<p>All of the functionality in this module is exposed through a Color constructor
and its prototype, but a few of its internals are available for direct use at
module level.</p>
</div>
<div class="section">
<h1><a id="api-reference" name="api-reference">API Reference</a></h1>
<div class="section">
<h2><a id="constructors" name="constructors">Constructors</a></h2>
<p>
<a name="fn-color"></a>
<a class="mochidef reference" href="#fn-color">Color()</a>:</p>
<blockquote>
<p>Represents a color. Component values should be integers between <tt class="docutils literal"><span class="pre">0.0</span></tt>
and <tt class="docutils literal"><span class="pre">1.0</span></tt>. You should use one of the <a class="mochiref reference" href="#fn-color">Color</a> factory
functions such as <a class="mochiref reference" href="#fn-color.fromrgb">Color.fromRGB</a>, <a class="mochiref reference" href="#fn-color.fromhsl">Color.fromHSL</a>,
etc. instead of constructing <a class="mochiref reference" href="#fn-color">Color</a> objects directly.</p>
<p><a class="mochiref reference" href="#fn-color">Color</a> instances can be compared with
<a class="mochiref reference" href="Base.html#fn-compare">MochiKit.Base.compare</a> (though ordering is on RGB, so is not
particularly meaningful except for equality), and the default <tt class="docutils literal"><span class="pre">toString</span></tt>
implementation returns <a class="mochiref reference" href="#fn-color.prototype.tohexstring">Color.prototype.toHexString()</a>.</p>
<p><a class="mochiref reference" href="#fn-color">Color</a> instances are immutable, and much of the architecture is
inspired by AppKit's NSColor <a class="footnote-reference" href="#id6" id="id1" name="id1">[1]</a></p>
</blockquote>
<p>
<a name="fn-color.frombackground"></a>
<a class="mochidef reference" href="#fn-color.frombackground">Color.fromBackground(elem)</a>:</p>
<blockquote>
<p>Returns a <a class="mochiref reference" href="#fn-color">Color</a> object based on the background of the provided
element. Equivalent to:</p>
<pre class="literal-block">
c = Color.fromComputedStyle(
elem, &quot;backgroundColor&quot;, &quot;background-color&quot;) || Color.whiteColor();
</pre>
</blockquote>
<p>
<a name="fn-color.fromcomputedstyle"></a>
<a class="mochidef reference" href="#fn-color.fromcomputedstyle">Color.fromComputedStyle(elem, style, mozillaEquivalentCSS)</a>:</p>
<blockquote>
Returns a <a class="mochiref reference" href="#fn-color">Color</a> object based on the result of
<a class="mochiref reference" href="DOM.html#fn-computedstyle">MochiKit.DOM.computedStyle(elem, style, mozillaEquivalentCSS)</a>
or <tt class="docutils literal"><span class="pre">null</span></tt> if not found.</blockquote>
<p>
<a name="fn-color.fromhexstring"></a>
<a class="mochidef reference" href="#fn-color.fromhexstring">Color.fromHexString(hexString)</a>:</p>
<blockquote>
Returns a <a class="mochiref reference" href="#fn-color">Color</a> object from the given hexadecimal color string.
For example, <tt class="docutils literal"><span class="pre">&quot;#FFFFFF&quot;</span></tt> would return a <a class="mochiref reference" href="#fn-color">Color</a> with
RGB values <tt class="docutils literal"><span class="pre">[255/255,</span> <span class="pre">255/255,</span> <span class="pre">255/255]</span></tt> (white).</blockquote>
<p>
<a name="fn-color.fromhsl"></a>
<a class="mochidef reference" href="#fn-color.fromhsl">Color.fromHSL(hue, saturation, lightness, alpha=1.0)</a>:</p>
<blockquote>
<p>Return a <a class="mochiref reference" href="#fn-color">Color</a> object from the given <tt class="docutils literal"><span class="pre">hue</span></tt>, <tt class="docutils literal"><span class="pre">saturation</span></tt>,
<tt class="docutils literal"><span class="pre">lightness</span></tt> values. Values should be numbers between <tt class="docutils literal"><span class="pre">0.0</span></tt> and
<tt class="docutils literal"><span class="pre">1.0</span></tt>.</p>
<p>If <tt class="docutils literal"><span class="pre">alpha</span></tt> is not given, then <tt class="docutils literal"><span class="pre">1.0</span></tt> (completely opaque) will be used.</p>
<dl class="docutils">
<dt>Alternate form:</dt>
<dd><a class="mochiref reference" href="#fn-color.fromhsl">Color.fromHSL({h: hue, s: saturation, l: lightness, a: alpha})</a></dd>
</dl>
</blockquote>
<p>
<a name="fn-color.fromhslstring"></a>
<a class="mochidef reference" href="#fn-color.fromhslstring">Color.fromHSLString(hslString)</a>:</p>
<blockquote>
Returns a <a class="mochiref reference" href="#fn-color">Color</a> object from the given decimal hsl color string.
For example, <tt class="docutils literal"><span class="pre">&quot;hsl(0,0%,100%)&quot;</span></tt> would return a <a class="mochiref reference" href="#fn-color">Color</a> with
HSL values <tt class="docutils literal"><span class="pre">[0/360,</span> <span class="pre">0/360,</span> <span class="pre">360/360]</span></tt> (white).</blockquote>
<p>
<a name="fn-color.fromhsv"></a>
<a class="mochidef reference" href="#fn-color.fromhsv">Color.fromHSV(hue, saturation, value, alpha=1.0)</a>:</p>
<blockquote>
<p>Return a <a class="mochiref reference" href="#fn-color">Color</a> object from the given <tt class="docutils literal"><span class="pre">hue</span></tt>, <tt class="docutils literal"><span class="pre">saturation</span></tt>,
<tt class="docutils literal"><span class="pre">value</span></tt> values. Values should be numbers between <tt class="docutils literal"><span class="pre">0.0</span></tt> and
<tt class="docutils literal"><span class="pre">1.0</span></tt>.</p>
<p>If <tt class="docutils literal"><span class="pre">alpha</span></tt> is not given, then <tt class="docutils literal"><span class="pre">1.0</span></tt> (completely opaque) will be used.</p>
<dl class="docutils">
<dt>Alternate form:</dt>
<dd><a class="mochiref reference" href="#fn-color.fromhsv">Color.fromHSV({h: hue, s: saturation, v: value, a: alpha})</a></dd>
</dl>
</blockquote>
<p>
<a name="fn-color.fromname"></a>
<a class="mochidef reference" href="#fn-color.fromname">Color.fromName(colorName)</a>:</p>
<blockquote>
Returns a <a class="mochiref reference" href="#fn-color">Color</a> object corresponding to the given
SVG 1.0 color keyword name <a class="footnote-reference" href="#id7" id="id2" name="id2">[2]</a> as per the W3C CSS3
Color Module <a class="footnote-reference" href="#id8" id="id3" name="id3">[3]</a>. <tt class="docutils literal"><span class="pre">&quot;transparent&quot;</span></tt> is also accepted
as a color name, and will return <a class="mochiref reference" href="#fn-color.transparentcolor">Color.transparentColor()</a>.</blockquote>
<p>
<a name="fn-color.fromrgb"></a>
<a class="mochidef reference" href="#fn-color.fromrgb">Color.fromRGB(red, green, blue, alpha=1.0)</a>:</p>
<blockquote>
<p>Return a <a class="mochiref reference" href="#fn-color">Color</a> object from the given <tt class="docutils literal"><span class="pre">red</span></tt>, <tt class="docutils literal"><span class="pre">green</span></tt>,
<tt class="docutils literal"><span class="pre">blue</span></tt>, and <tt class="docutils literal"><span class="pre">alpha</span></tt> values. Values should be numbers between <tt class="docutils literal"><span class="pre">0</span></tt>
and <tt class="docutils literal"><span class="pre">1.0</span></tt>.</p>
<p>If <tt class="docutils literal"><span class="pre">alpha</span></tt> is not given, then <tt class="docutils literal"><span class="pre">1.0</span></tt> (completely opaque) will be used.</p>
<dl class="docutils">
<dt>Alternate form:</dt>
<dd><a class="mochiref reference" href="#fn-color.fromrgb">Color.fromRGB({r: red, g: green, b: blue, a: alpha})</a></dd>
</dl>
</blockquote>
<p>
<a name="fn-color.fromrgbstring"></a>
<a class="mochidef reference" href="#fn-color.fromrgbstring">Color.fromRGBString(rgbString)</a>:</p>
<blockquote>
Returns a <a class="mochiref reference" href="#fn-color">Color</a> object from the given decimal rgb color string.
For example, <tt class="docutils literal"><span class="pre">&quot;rgb(255,255,255)&quot;</span></tt> would return a <a class="mochiref reference" href="#fn-color">Color</a> with
RGB values <tt class="docutils literal"><span class="pre">[255/255,</span> <span class="pre">255/255,</span> <span class="pre">255/255]</span></tt> (white).</blockquote>
<p>
<a name="fn-color.fromtext"></a>
<a class="mochidef reference" href="#fn-color.fromtext">Color.fromText(elem)</a>:</p>
<blockquote>
<p>Returns a <a class="mochiref reference" href="#fn-color">Color</a> object based on the text color of the provided
element. Equivalent to:</p>
<pre class="literal-block">
c = Color.fromComputedStyle(elem, &quot;color&quot;) || Color.whiteColor();
</pre>
</blockquote>
<p>
<a name="fn-color.fromstring"></a>
<a class="mochidef reference" href="#fn-color.fromstring">Color.fromString(rgbOrHexString)</a>:</p>
<blockquote>
<p>Returns a <a class="mochiref reference" href="#fn-color">Color</a> object from the given RGB, HSL, hex, or name.
Will return <tt class="docutils literal"><span class="pre">null</span></tt> if the string can not be parsed by any of these
methods.</p>
<p>See <a class="mochiref reference" href="#fn-color.fromhexstring">Color.fromHexString</a>, <a class="mochiref reference" href="#fn-color.fromrgbstring">Color.fromRGBString</a>,
<a class="mochiref reference" href="#fn-color.fromhslstring">Color.fromHSLString</a> and <a class="mochiref reference" href="#fn-color.fromname">Color.fromName</a> more
information.</p>
</blockquote>
<p>
<a name="fn-color.namedcolors"></a>
<a class="mochidef reference" href="#fn-color.namedcolors">Color.namedColors()</a>:</p>
<blockquote>
Returns an object with properties for each SVG 1.0 color keyword
name <a class="footnote-reference" href="#id7" id="id4" name="id4">[2]</a> supported by CSS3 <a class="footnote-reference" href="#id8" id="id5" name="id5">[3]</a>. Property names are the color keyword
name in lowercase, and the value is a string suitable for
<a class="mochiref reference" href="#fn-color.fromstring">Color.fromString()</a>.</blockquote>
<p>
<a name="fn-color.prototype.colorwithalpha"></a>
<a class="mochidef reference" href="#fn-color.prototype.colorwithalpha">Color.prototype.colorWithAlpha(alpha)</a>:</p>
<blockquote>
Return a new <a class="mochiref reference" href="#fn-color">Color</a> based on this color, but with the provided
<tt class="docutils literal"><span class="pre">alpha</span></tt> value.</blockquote>
<p>
<a name="fn-color.prototype.colorwithhue"></a>
<a class="mochidef reference" href="#fn-color.prototype.colorwithhue">Color.prototype.colorWithHue(hue)</a>:</p>
<blockquote>
Return a new <a class="mochiref reference" href="#fn-color">Color</a> based on this color, but with the provided
<tt class="docutils literal"><span class="pre">hue</span></tt> value.</blockquote>
<p>
<a name="fn-color.prototype.colorwithsaturation"></a>
<a class="mochidef reference" href="#fn-color.prototype.colorwithsaturation">Color.prototype.colorWithSaturation(saturation)</a>:</p>
<blockquote>
Return a new <a class="mochiref reference" href="#fn-color">Color</a> based on this color, but with the provided
<tt class="docutils literal"><span class="pre">saturation</span></tt> value (using the HSL color model).</blockquote>
<p>
<a name="fn-color.prototype.colorwithlightness"></a>
<a class="mochidef reference" href="#fn-color.prototype.colorwithlightness">Color.prototype.colorWithLightness(lightness)</a>:</p>
<blockquote>
Return a new <a class="mochiref reference" href="#fn-color">Color</a> based on this color, but with the provided
<tt class="docutils literal"><span class="pre">lightness</span></tt> value.</blockquote>
<p>
<a name="fn-color.prototype.darkercolorwithlevel"></a>
<a class="mochidef reference" href="#fn-color.prototype.darkercolorwithlevel">Color.prototype.darkerColorWithLevel(level)</a>:</p>
<blockquote>
Return a new <a class="mochiref reference" href="#fn-color">Color</a> based on this color, but darker by the given
<tt class="docutils literal"><span class="pre">level</span></tt> (between <tt class="docutils literal"><span class="pre">0</span></tt> and <tt class="docutils literal"><span class="pre">1.0</span></tt>).</blockquote>
<p>
<a name="fn-color.prototype.lightercolorwithlevel"></a>
<a class="mochidef reference" href="#fn-color.prototype.lightercolorwithlevel">Color.prototype.lighterColorWithLevel(level)</a>:</p>
<blockquote>
Return a new <a class="mochiref reference" href="#fn-color">Color</a> based on this color, but lighter by the given
<tt class="docutils literal"><span class="pre">level</span></tt> (between <tt class="docutils literal"><span class="pre">0</span></tt> and <tt class="docutils literal"><span class="pre">1.0</span></tt>).</blockquote>
<p>
<a name="fn-color.prototype.blendedcolor"></a>
<a class="mochidef reference" href="#fn-color.prototype.blendedcolor">Color.prototype.blendedColor(other, fraction=0.5)</a>:</p>
<blockquote>
Return a new <a class="mochiref reference" href="#fn-color">Color</a> whose RGBA component values are a weighted sum
of this color and <tt class="docutils literal"><span class="pre">other</span></tt>. Each component of the returned color
is the <tt class="docutils literal"><span class="pre">fraction</span></tt> of other's value plus <tt class="docutils literal"><span class="pre">1</span> <span class="pre">-</span> <span class="pre">fraction</span></tt> of this
color's.</blockquote>
<p>
<a name="fn-color.prototype.islight"></a>
<a class="mochidef reference" href="#fn-color.prototype.islight">Color.prototype.isLight()</a>:</p>
<blockquote>
<p>Return <tt class="docutils literal"><span class="pre">true</span></tt> if the lightness value of this color is greater than
<tt class="docutils literal"><span class="pre">0.5</span></tt>.</p>
<p>Note that <tt class="docutils literal"><span class="pre">alpha</span></tt> is ignored for this calculation (color components
are not premultiplied).</p>
</blockquote>
<p>
<a name="fn-color.prototype.isdark"></a>
<a class="mochidef reference" href="#fn-color.prototype.isdark">Color.prototype.isDark()</a>:</p>
<blockquote>
<p>Return <tt class="docutils literal"><span class="pre">true</span></tt> if the lightness value of this color is less than or
equal to <tt class="docutils literal"><span class="pre">0.5</span></tt>.</p>
<p>Note that <tt class="docutils literal"><span class="pre">alpha</span></tt> is ignored for this calculation (color components
are not premultiplied).</p>
</blockquote>
<p>
<a name="fn-color.prototype.torgbstring"></a>
<a class="mochidef reference" href="#fn-color.prototype.torgbstring">Color.prototype.toRGBString()</a>:</p>
<blockquote>
<p>Return the decimal <tt class="docutils literal"><span class="pre">&quot;rgb(red,</span> <span class="pre">green,</span> <span class="pre">blue)&quot;</span></tt> string representation of this
color.</p>
<p>If the alpha component is not <tt class="docutils literal"><span class="pre">1.0</span></tt> (fully opaque), the
<tt class="docutils literal"><span class="pre">&quot;rgba(red,</span> <span class="pre">green,</span> <span class="pre">blue,</span> <span class="pre">alpha)&quot;</span></tt> string representation will be used.</p>
<p>For example:</p>
<pre class="literal-block">
assert( Color.whiteColor().toRGBString() == &quot;rgb(255,255,255)&quot; );
</pre>
</blockquote>
<p>
<a name="fn-color.prototype.tohslstring"></a>
<a class="mochidef reference" href="#fn-color.prototype.tohslstring">Color.prototype.toHSLString()</a>:</p>
<blockquote>
<p>Return the decimal <tt class="docutils literal"><span class="pre">&quot;hsl(hue,</span> <span class="pre">saturation,</span> <span class="pre">lightness)&quot;</span></tt>
string representation of this color.</p>
<p>If the alpha component is not <tt class="docutils literal"><span class="pre">1.0</span></tt> (fully opaque), the
<tt class="docutils literal"><span class="pre">&quot;hsla(hue,</span> <span class="pre">saturation,</span> <span class="pre">lightness,</span> <span class="pre">alpha)&quot;</span></tt> string representation
will be used.</p>
<p>For example:</p>
<pre class="literal-block">
assert( Color.whiteColor().toHSLString() == &quot;hsl(0,0,360)&quot; );
</pre>
</blockquote>
<p>
<a name="fn-color.prototype.tohexstring"></a>
<a class="mochidef reference" href="#fn-color.prototype.tohexstring">Color.prototype.toHexString()</a>:</p>
<blockquote>
<p>Return the hexadecimal <tt class="docutils literal"><span class="pre">&quot;#RRGGBB&quot;</span></tt> string representation of this color.</p>
<p>Note that the alpha component is completely ignored for hexadecimal
string representations!</p>
<p>For example:</p>
<pre class="literal-block">
assert( Color.whiteColor().toHexString() == &quot;#FFFFFF&quot; );
</pre>
</blockquote>
<p>
<a name="fn-color.prototype.asrgb"></a>
<a class="mochidef reference" href="#fn-color.prototype.asrgb">Color.prototype.asRGB()</a>:</p>
<blockquote>
Return the RGB (red, green, blue, alpha) components of this color as an
object with <tt class="docutils literal"><span class="pre">r</span></tt>, <tt class="docutils literal"><span class="pre">g</span></tt>, <tt class="docutils literal"><span class="pre">b</span></tt>, and <tt class="docutils literal"><span class="pre">a</span></tt> properties that have
values between <tt class="docutils literal"><span class="pre">0.0</span></tt> and <tt class="docutils literal"><span class="pre">1.0</span></tt>.</blockquote>
<p>
<a name="fn-color.prototype.ashsl"></a>
<a class="mochidef reference" href="#fn-color.prototype.ashsl">Color.prototype.asHSL()</a>:</p>
<blockquote>
Return the HSL (hue, saturation, lightness, alpha) components of this
color as an object with <tt class="docutils literal"><span class="pre">h</span></tt>, <tt class="docutils literal"><span class="pre">s</span></tt>, <tt class="docutils literal"><span class="pre">l</span></tt> and <tt class="docutils literal"><span class="pre">a</span></tt> properties
that have values between <tt class="docutils literal"><span class="pre">0.0</span></tt> and <tt class="docutils literal"><span class="pre">1.0</span></tt>.</blockquote>
<p>
<a name="fn-color.prototype.ashsv"></a>
<a class="mochidef reference" href="#fn-color.prototype.ashsv">Color.prototype.asHSV()</a>:</p>
<blockquote>
Return the HSV (hue, saturation, value, alpha) components of this
color as an object with <tt class="docutils literal"><span class="pre">h</span></tt>, <tt class="docutils literal"><span class="pre">s</span></tt>, <tt class="docutils literal"><span class="pre">v</span></tt> and <tt class="docutils literal"><span class="pre">a</span></tt> properties
that have values between <tt class="docutils literal"><span class="pre">0.0</span></tt> and <tt class="docutils literal"><span class="pre">1.0</span></tt>.</blockquote>
<p>
<a name="fn-color.blackcolor"></a>
<a class="mochidef reference" href="#fn-color.blackcolor">Color.blackColor()</a>:</p>
<blockquote>
Return a <a class="mochiref reference" href="#fn-color">Color</a> object whose RGB values are 0, 0, 0
(#000000).</blockquote>
<p>
<a name="fn-color.bluecolor"></a>
<a class="mochidef reference" href="#fn-color.bluecolor">Color.blueColor()</a>:</p>
<blockquote>
Return a <a class="mochiref reference" href="#fn-color">Color</a> object whose RGB values are 0, 0, 1
(#0000ff).</blockquote>
<p>
<a name="fn-color.browncolor"></a>
<a class="mochidef reference" href="#fn-color.browncolor">Color.brownColor()</a>:</p>
<blockquote>
Return a <a class="mochiref reference" href="#fn-color">Color</a> object whose RGB values are 0.6, 0.4, 0.2
(#996633).</blockquote>
<p>
<a name="fn-color.cyancolor"></a>
<a class="mochidef reference" href="#fn-color.cyancolor">Color.cyanColor()</a>:</p>
<blockquote>
Return a <a class="mochiref reference" href="#fn-color">Color</a> object whose RGB values are 0, 1, 1
(#00ffff).</blockquote>
<p>
<a name="fn-color.darkgraycolor"></a>
<a class="mochidef reference" href="#fn-color.darkgraycolor">Color.darkGrayColor()</a>:</p>
<blockquote>
Return a <a class="mochiref reference" href="#fn-color">Color</a> object whose RGB values are 1/3, 1/3, 1/3
(#555555).</blockquote>
<p>
<a name="fn-color.graycolor"></a>
<a class="mochidef reference" href="#fn-color.graycolor">Color.grayColor()</a>:</p>
<blockquote>
Return a <a class="mochiref reference" href="#fn-color">Color</a> object whose RGB values are 0.5, 0.5, 0.5
(#808080).</blockquote>
<p>
<a name="fn-color.greencolor"></a>
<a class="mochidef reference" href="#fn-color.greencolor">Color.greenColor()</a>:</p>
<blockquote>
Return a <a class="mochiref reference" href="#fn-color">Color</a> object whose RGB values are 0, 1, 0.
(#00ff00).</blockquote>
<p>
<a name="fn-color.lightgraycolor"></a>
<a class="mochidef reference" href="#fn-color.lightgraycolor">Color.lightGrayColor()</a>:</p>
<blockquote>
Return a <a class="mochiref reference" href="#fn-color">Color</a> object whose RGB values are 2/3, 2/3, 2/3
(#aaaaaa).</blockquote>
<p>
<a name="fn-color.magentacolor"></a>
<a class="mochidef reference" href="#fn-color.magentacolor">Color.magentaColor()</a>:</p>
<blockquote>
Return a <a class="mochiref reference" href="#fn-color">Color</a> object whose RGB values are 1, 0, 1
(#ff00ff).</blockquote>
<p>
<a name="fn-color.orangecolor"></a>
<a class="mochidef reference" href="#fn-color.orangecolor">Color.orangeColor()</a>:</p>
<blockquote>
Return a <a class="mochiref reference" href="#fn-color">Color</a> object whose RGB values are 1, 0.5, 0
(#ff8000).</blockquote>
<p>
<a name="fn-color.purplecolor"></a>
<a class="mochidef reference" href="#fn-color.purplecolor">Color.purpleColor()</a>:</p>
<blockquote>
Return a <a class="mochiref reference" href="#fn-color">Color</a> object whose RGB values are 0.5, 0, 0.5
(#800080).</blockquote>
<p>
<a name="fn-color.redcolor"></a>
<a class="mochidef reference" href="#fn-color.redcolor">Color.redColor()</a>:</p>
<blockquote>
Return a <a class="mochiref reference" href="#fn-color">Color</a> object whose RGB values are 1, 0, 0
(#ff0000).</blockquote>
<p>
<a name="fn-color.whitecolor"></a>
<a class="mochidef reference" href="#fn-color.whitecolor">Color.whiteColor()</a>:</p>
<blockquote>
Return a <a class="mochiref reference" href="#fn-color">Color</a> object whose RGB values are 1, 1, 1
(#ffffff).</blockquote>
<p>
<a name="fn-color.yellowcolor"></a>
<a class="mochidef reference" href="#fn-color.yellowcolor">Color.yellowColor()</a>:</p>
<blockquote>
Return a <a class="mochiref reference" href="#fn-color">Color</a> object whose RGB values are 1, 1, 0
(#ffff00).</blockquote>
<p>
<a name="fn-color.transparentcolor"></a>
<a class="mochidef reference" href="#fn-color.transparentcolor">Color.transparentColor()</a>:</p>
<blockquote>
Return a <a class="mochiref reference" href="#fn-color">Color</a> object that is completely transparent
(has alpha component of 0).</blockquote>
</div>
<div class="section">
<h2><a id="functions" name="functions">Functions</a></h2>
<p>
<a name="fn-clampcolorcomponent"></a>
<a class="mochidef reference" href="#fn-clampcolorcomponent">clampColorComponent(num, scale)</a>:</p>
<blockquote>
<p>Returns <tt class="docutils literal"><span class="pre">num</span> <span class="pre">*</span> <span class="pre">scale</span></tt> clamped between <tt class="docutils literal"><span class="pre">0</span></tt> and <tt class="docutils literal"><span class="pre">scale</span></tt>.</p>
<p><a class="mochiref reference" href="#fn-clampcolorcomponent">clampColorComponent</a> is not exported by default when using JSAN.</p>
</blockquote>
<p>
<a name="fn-hsltorgb"></a>
<a class="mochidef reference" href="#fn-hsltorgb">hslToRGB(hue, saturation, lightness, alpha)</a>:</p>
<blockquote>
<p>Computes RGB values from the provided HSL values. The return value is a
mapping with <tt class="docutils literal"><span class="pre">&quot;r&quot;</span></tt>, <tt class="docutils literal"><span class="pre">&quot;g&quot;</span></tt>, <tt class="docutils literal"><span class="pre">&quot;b&quot;</span></tt> and <tt class="docutils literal"><span class="pre">&quot;a&quot;</span></tt> keys.</p>
<dl class="docutils">
<dt>Alternate form:</dt>
<dd><a class="mochiref reference" href="#fn-hsltorgb">hslToRGB({h: hue, s: saturation, l: lightness, a: alpha})</a>.</dd>
</dl>
<p><a class="mochiref reference" href="#fn-hsltorgb">hslToRGB</a> is not exported by default when using JSAN.</p>
</blockquote>
<p>
<a name="fn-hsvtorgb"></a>
<a class="mochidef reference" href="#fn-hsvtorgb">hsvToRGB(hue, saturation, value, alpha)</a>:</p>
<blockquote>
<p>Computes RGB values from the provided HSV values. The return value is a
mapping with <tt class="docutils literal"><span class="pre">&quot;r&quot;</span></tt>, <tt class="docutils literal"><span class="pre">&quot;g&quot;</span></tt>, <tt class="docutils literal"><span class="pre">&quot;b&quot;</span></tt> and <tt class="docutils literal"><span class="pre">&quot;a&quot;</span></tt> keys.</p>
<dl class="docutils">
<dt>Alternate form:</dt>
<dd><a class="mochiref reference" href="#fn-hsvtorgb">hsvToRGB({h: hue, s: saturation, v: value, a: alpha})</a>.</dd>
</dl>
<p><a class="mochiref reference" href="#fn-hsvtorgb">hsvToRGB</a> is not exported by default when using JSAN.</p>
</blockquote>
<p>
<a name="fn-tocolorpart"></a>
<a class="mochidef reference" href="#fn-tocolorpart">toColorPart(num)</a>:</p>
<blockquote>
<p>Convert num to a zero padded hexadecimal digit for use in a hexadecimal
color string. Num should be an integer between <tt class="docutils literal"><span class="pre">0</span></tt> and <tt class="docutils literal"><span class="pre">255</span></tt>.</p>
<p><a class="mochiref reference" href="#fn-tocolorpart">toColorPart</a> is not exported by default when using JSAN.</p>
</blockquote>
<p>
<a name="fn-rgbtohsl"></a>
<a class="mochidef reference" href="#fn-rgbtohsl">rgbToHSL(red, green, blue, alpha)</a>:</p>
<blockquote>
<p>Computes HSL values based on the provided RGB values. The return value is
a mapping with <tt class="docutils literal"><span class="pre">&quot;h&quot;</span></tt>, <tt class="docutils literal"><span class="pre">&quot;s&quot;</span></tt>, <tt class="docutils literal"><span class="pre">&quot;l&quot;</span></tt> and <tt class="docutils literal"><span class="pre">&quot;a&quot;</span></tt> keys.</p>
<dl class="docutils">
<dt>Alternate form:</dt>
<dd><a class="mochiref reference" href="#fn-rgbtohsl">rgbToHSL({r: red, g: green, b: blue, a: alpha})</a>.</dd>
</dl>
<p><a class="mochiref reference" href="#fn-rgbtohsl">rgbToHSL</a> is not exported by default when using JSAN.</p>
</blockquote>
<p>
<a name="fn-rgbtohsv"></a>
<a class="mochidef reference" href="#fn-rgbtohsv">rgbToHSV(red, green, blue, alpha)</a>:</p>
<blockquote>
<p>Computes HSV values based on the provided RGB values. The return value is
a mapping with <tt class="docutils literal"><span class="pre">&quot;h&quot;</span></tt>, <tt class="docutils literal"><span class="pre">&quot;s&quot;</span></tt>, <tt class="docutils literal"><span class="pre">&quot;v&quot;</span></tt> and <tt class="docutils literal"><span class="pre">&quot;a&quot;</span></tt> keys.</p>
<dl class="docutils">
<dt>Alternate form:</dt>
<dd><a class="mochiref reference" href="#fn-rgbtohsv">rgbToHSV({r: red, g: green, b: blue, a: alpha})</a>.</dd>
</dl>
<p><a class="mochiref reference" href="#fn-rgbtohsv">rgbToHSV</a> is not exported by default when using JSAN.</p>
</blockquote>
</div>
</div>
<div class="section">
<h1><a id="see-also" name="see-also">See Also</a></h1>
<table class="docutils footnote" frame="void" id="id6" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id1" name="id6">[1]</a></td><td>Application Kit Reference - NSColor: <a class="reference" href="http://developer.apple.com/documentation/Cocoa/Reference/ApplicationKit/ObjC_classic/Classes/NSColor.html">http://developer.apple.com/documentation/Cocoa/Reference/ApplicationKit/ObjC_classic/Classes/NSColor.html</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id7" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a name="id7">[2]</a></td><td><em>(<a class="fn-backref" href="#id2">1</a>, <a class="fn-backref" href="#id4">2</a>)</em> SVG 1.0 color keywords: <a class="reference" href="http://www.w3.org/TR/SVG/types.html#ColorKeywords">http://www.w3.org/TR/SVG/types.html#ColorKeywords</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id8" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a name="id8">[3]</a></td><td><em>(<a class="fn-backref" href="#id3">1</a>, <a class="fn-backref" href="#id5">2</a>)</em> W3C CSS3 Color Module: <a class="reference" href="http://www.w3.org/TR/css3-color/#svg-color">http://www.w3.org/TR/css3-color/#svg-color</a></td></tr>
</tbody>
</table>
</div>
<div class="section">
<h1><a id="authors" name="authors">Authors</a></h1>
<ul class="simple">
<li>Bob Ippolito &lt;<a class="reference" href="mailto:bob&#64;redivi.com">bob&#64;redivi.com</a>&gt;</li>
</ul>
</div>
<div class="section">
<h1><a id="copyright" name="copyright">Copyright</a></h1>
<p>Copyright 2005 Bob Ippolito &lt;<a class="reference" href="mailto:bob&#64;redivi.com">bob&#64;redivi.com</a>&gt;. This program is dual-licensed
free software; you can redistribute it and/or modify it under the terms of the
<a class="reference" href="http://www.opensource.org/licenses/mit-license.php">MIT License</a> or the <a class="reference" href="http://www.opensource.org/licenses/afl-2.1.php">Academic Free License v2.1</a>.</p>
</div>
</div>
</body>
</html>

View File

@@ -1,798 +0,0 @@
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
<title>MochiKit.DOM - painless DOM manipulation API</title>
<link rel="stylesheet" href="../../../include/css/documentation.css" type="text/css" />
<script type="text/javascript" src="../../../packed/lib/MochiKit/MochiKit.js"></script>
<script type="text/javascript" src="../../js/toc.js"></script>
</head>
<body>
<div class="document">
<div class="section">
<h1><a id="name" name="name">Name</a></h1>
<p>MochiKit.DOM - painless DOM manipulation API</p>
</div>
<div class="section">
<h1><a id="synopsis" name="synopsis">Synopsis</a></h1>
<pre class="literal-block">
var rows = [
[&quot;dataA1&quot;, &quot;dataA2&quot;, &quot;dataA3&quot;],
[&quot;dataB1&quot;, &quot;dataB2&quot;, &quot;dataB3&quot;]
];
row_display = function (row) {
return TR(null, map(partial(TD, null), row));
}
var newTable = TABLE({'class': 'prettytable'},
THEAD(null,
row_display([&quot;head1&quot;, &quot;head2&quot;, &quot;head3&quot;])),
TFOOT(null,
row_display([&quot;foot1&quot;, &quot;foot2&quot;, &quot;foot3&quot;])),
TBODY(null,
map(row_display, rows)));
// put that in your document.createElement and smoke it!
swapDOM(oldTable, newTable);
</pre>
</div>
<div class="section">
<h1><a id="description" name="description">Description</a></h1>
<p>As you probably know, the DOM APIs are some of the most painful Java-inspired
APIs you'll run across from a highly dynamic language. Don't worry about that
though, because they provide a reasonable basis to build something that
sucks a lot less.</p>
<p>MochiKit.DOM takes much of its inspiration from Nevow's <a class="footnote-reference" href="#id5" id="id1" name="id1">[1]</a> stan <a class="footnote-reference" href="#id6" id="id2" name="id2">[2]</a>.
This means you choose a tag, give it some attributes, then stuff it full
of <em>whatever objects you want</em>. MochiKit.DOM isn't stupid, it knows that
a string should be a text node, and that you want functions to be called,
and that <tt class="docutils literal"><span class="pre">Array</span></tt>-like objects should be expanded, and stupid <tt class="docutils literal"><span class="pre">null</span></tt> values
should be skipped.</p>
<p>Hell, it will let you return strings from functions, and use iterators from
<a class="mochiref reference" href="Iter.html">MochiKit.Iter</a>. If that's not enough, just teach it new tricks with
<a class="mochiref reference" href="#fn-registerdomconverter">registerDOMConverter</a>. If you have never used an API like this for
creating DOM elements, you've been wasting your damn time. Get with it!</p>
</div>
<div class="section">
<h1><a id="dependencies" name="dependencies">Dependencies</a></h1>
<ul class="simple">
<li><a class="mochiref reference" href="Base.html">MochiKit.Base</a></li>
<li><a class="mochiref reference" href="Iter.html">MochiKit.Iter</a></li>
</ul>
</div>
<div class="section">
<h1><a id="overview" name="overview">Overview</a></h1>
<div class="section">
<h2><a id="dom-coercion-rules" name="dom-coercion-rules">DOM Coercion Rules</a></h2>
<p>In order of precedence, <a class="mochiref reference" href="#fn-createdom">createDOM</a> coerces given arguments to DOM
nodes using the following rules:</p>
<ol class="arabic simple">
<li>Functions are called with a <tt class="docutils literal"><span class="pre">this</span></tt> of the parent
node and their return value is subject to the
following rules (even this one).</li>
<li><tt class="docutils literal"><span class="pre">undefined</span></tt> and <tt class="docutils literal"><span class="pre">null</span></tt> are ignored.</li>
<li>Iterables (see <a class="mochiref reference" href="Iter.html">MochiKit.Iter</a>) are flattened
(as if they were passed in-line as nodes) and each
return value is subject to all of these rules.</li>
<li>Values that look like DOM nodes (objects with a
<tt class="docutils literal"><span class="pre">.nodeType</span> <span class="pre">&gt;</span> <span class="pre">0</span></tt>) are <tt class="docutils literal"><span class="pre">.appendChild</span></tt>'ed to the created
DOM fragment.</li>
<li>Strings are wrapped up with <tt class="docutils literal"><span class="pre">document.createTextNode</span></tt></li>
<li>Objects that are not strings are run through the <tt class="docutils literal"><span class="pre">domConverters</span></tt>
<a class="mochiref reference" href="Base.html#fn-adapterregistry">MochiKit.Base.AdapterRegistry</a>
(see <a class="mochiref reference" href="#fn-registerdomconverter">registerDOMConverter</a>).
The value returned by the adapter is subject to these same rules (e.g.
adapters are allowed to return a string, which will be coerced into a
text node).</li>
<li>If no adapter is available, <tt class="docutils literal"><span class="pre">.toString()</span></tt> is used to create a text node.</li>
</ol>
</div>
<div class="section">
<h2><a id="creating-dom-element-trees" name="creating-dom-element-trees">Creating DOM Element Trees</a></h2>
<p><a class="mochiref reference" href="#fn-createdom">createDOM</a> provides you with an excellent facility for creating DOM trees
that is easy on the wrists. One of the best ways to understand how to use
it is to take a look at an example:</p>
<pre class="literal-block">
var rows = [
[&quot;dataA1&quot;, &quot;dataA2&quot;, &quot;dataA3&quot;],
[&quot;dataB1&quot;, &quot;dataB2&quot;, &quot;dataB3&quot;]
];
row_display = function (row) {
return TR(null, map(partial(TD, null), row));
}
var newTable = TABLE({'class': 'prettytable'},
THEAD(null,
row_display([&quot;head1&quot;, &quot;head2&quot;, &quot;head3&quot;])),
TFOOT(null,
row_display([&quot;foot1&quot;, &quot;foot2&quot;, &quot;foot3&quot;])),
TBODY(null,
map(row_display, rows)));
</pre>
<p>This will create a table with the following visual layout (if it
were inserted into the document DOM):</p>
<blockquote>
<table border="1" class="docutils">
<colgroup>
<col width="33%" />
<col width="33%" />
<col width="33%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">head1</th>
<th class="head">head2</th>
<th class="head">head3</th>
</tr>
</thead>
<tbody valign="top">
<tr><td>dataA1</td>
<td>dataA2</td>
<td>dataA3</td>
</tr>
<tr><td>dataB1</td>
<td>dataB2</td>
<td>dataB3</td>
</tr>
<tr><td>foot1</td>
<td>foot2</td>
<td>foot3</td>
</tr>
</tbody>
</table>
</blockquote>
<p>Corresponding to the following HTML:</p>
<pre class="literal-block">
&lt;table class=&quot;prettytable&quot;&gt;
&lt;thead&gt;
&lt;tr&gt;
&lt;td&gt;head1&lt;/td&gt;
&lt;td&gt;head2&lt;/td&gt;
&lt;td&gt;head3&lt;/td&gt;
&lt;/tr&gt;
&lt;/thead&gt;
&lt;tfoot&gt;
&lt;tr&gt;
&lt;td&gt;foot1&lt;/td&gt;
&lt;td&gt;foot2&lt;/td&gt;
&lt;td&gt;foot3&lt;/td&gt;
&lt;/tr&gt;
&lt;/tfoot&gt;
&lt;tbody&gt;
&lt;tr&gt;
&lt;td&gt;dataA1&lt;/td&gt;
&lt;td&gt;dataA2&lt;/td&gt;
&lt;td&gt;dataA3&lt;/td&gt;
&lt;/tr&gt;
&lt;tr&gt;
&lt;td&gt;dataB1&lt;/td&gt;
&lt;td&gt;dataB2&lt;/td&gt;
&lt;td&gt;dataB3&lt;/td&gt;
&lt;/tr&gt;
&lt;/tbody&gt;
&lt;/table&gt;
</pre>
</div>
<div class="section">
<h2><a id="dom-context" name="dom-context">DOM Context</a></h2>
<p>In order to prevent having to pass a <tt class="docutils literal"><span class="pre">window</span></tt> and/or <tt class="docutils literal"><span class="pre">document</span></tt>
variable to every MochiKit.DOM function (e.g. when working with a
child window), MochiKit.DOM maintains a context variable for each
of them. They are managed with the <a class="mochiref reference" href="#fn-withwindow">withWindow</a> and
<a class="mochiref reference" href="#fn-withdocument">withDocument</a> functions, and can be acquired with
<a class="mochiref reference" href="#fn-currentwindow">currentWindow()</a> and <a class="mochiref reference" href="#fn-currentdocument">currentDocument()</a></p>
<p>For example, if you are creating DOM nodes in a child window, you
could do something like this:</p>
<pre class="literal-block">
withWindow(child, function () {
var doc = currentDocument();
appendChildNodes(doc.body, H1(null, &quot;This is in the child!&quot;));
});
</pre>
<p>Note that <a class="mochiref reference" href="#fn-withwindow">withWindow(win, ...)</a> also implies
<a class="mochiref reference" href="#fn-withdocument">withDocument(win.document, ...)</a>.</p>
</div>
<div class="section">
<h2><a id="element-visibility" name="element-visibility">Element Visibility</a></h2>
<p>The <a class="mochiref reference" href="#fn-hideelement">hideElement</a> and <a class="mochiref reference" href="#fn-showelement">showElement</a> functions are
provided as a convenience, but only work for elements that are
<tt class="docutils literal"><span class="pre">display:</span> <span class="pre">block</span></tt>. For a general solution to showing, hiding, and checking
the explicit visibility of elements, we recommend using a solution that
involves a little CSS. Here's an example:</p>
<pre class="literal-block">
&lt;style type=&quot;text/css&quot;&gt;
.invisible { display: none; }
&lt;/style&gt;
&lt;script type=&quot;text/javascript&quot;&gt;
function toggleVisible(elem) {
toggleElementClass(&quot;invisible&quot;, elem);
}
function makeVisible(elem) {
removeElementClass(elem, &quot;invisible&quot;);
}
function makeInvisible(elem) {
addElementClass(elem, &quot;invisible&quot;);
}
function isVisible(elem) {
// you may also want to check for
// getElement(elem).style.display == &quot;none&quot;
return !hasElementClass(elem, &quot;invisible&quot;);
};
&lt;/script&gt;
</pre>
<p>MochiKit doesn't ship with such a solution, because there is no reliable and
portable method for adding CSS rules on the fly with JavaScript.</p>
</div>
</div>
<div class="section">
<h1><a id="api-reference" name="api-reference">API Reference</a></h1>
<div class="section">
<h2><a id="functions" name="functions">Functions</a></h2>
<p>
<a name="fn-$"></a>
<a class="mochidef reference" href="#fn-$">$(id[, ...])</a>:</p>
<blockquote>
An alias for <a class="mochiref reference" href="#fn-getelement">getElement(id[, ...])</a></blockquote>
<p>
<a name="fn-addelementclass"></a>
<a class="mochidef reference" href="#fn-addelementclass">addElementClass(element, className)</a>:</p>
<blockquote>
Ensure that the given <tt class="docutils literal"><span class="pre">element</span></tt> has <tt class="docutils literal"><span class="pre">className</span></tt> set as part of its
class attribute. This will not disturb other class names.
<tt class="docutils literal"><span class="pre">element</span></tt> is looked up with <a class="mochiref reference" href="#fn-getelement">getElement</a>, so string identifiers
are also acceptable.</blockquote>
<p>
<a name="fn-addloadevent"></a>
<a class="mochidef reference" href="#fn-addloadevent">addLoadEvent(func)</a>:</p>
<blockquote>
<p>Note that <a class="mochiref reference" href="#fn-addloadevent">addLoadEvent</a> can not be used in combination with
<a class="mochiref reference" href="Signal.html">MochiKit.Signal</a> if the <tt class="docutils literal"><span class="pre">onload</span></tt> event is connected.
Once an event is connected with <a class="mochiref reference" href="Signal.html">MochiKit.Signal</a>, no other APIs
may be used for that same event.</p>
<p>This will stack <tt class="docutils literal"><span class="pre">window.onload</span></tt> functions on top of each other.
Each function added will be called after <tt class="docutils literal"><span class="pre">onload</span></tt> in the
order that they were added.</p>
</blockquote>
<p>
<a name="fn-addtocallstack"></a>
<a class="mochidef reference" href="#fn-addtocallstack">addToCallStack(target, path, func[, once])</a>:</p>
<blockquote>
<p>Note that <a class="mochiref reference" href="#fn-addtocallstack">addToCallStack</a> is not compatible with
<a class="mochiref reference" href="Signal.html">MochiKit.Signal</a>. Once an event is connected with
<a class="mochiref reference" href="Signal.html">MochiKit.Signal</a>, no other APIs may be used for that same event.</p>
<p>Set the property <tt class="docutils literal"><span class="pre">path</span></tt> of <tt class="docutils literal"><span class="pre">target</span></tt> to a function that calls the
existing function at that property (if any), then calls <tt class="docutils literal"><span class="pre">func</span></tt>.</p>
<p>If <tt class="docutils literal"><span class="pre">target[path]()</span></tt> returns exactly <tt class="docutils literal"><span class="pre">false</span></tt>, then <tt class="docutils literal"><span class="pre">func</span></tt> will
not be called.</p>
<p>If <tt class="docutils literal"><span class="pre">once</span></tt> is <tt class="docutils literal"><span class="pre">true</span></tt>, then <tt class="docutils literal"><span class="pre">target[path]</span></tt> is set to <tt class="docutils literal"><span class="pre">null</span></tt> after
the function call stack has completed.</p>
<p>If called several times for the same <tt class="docutils literal"><span class="pre">target[path]</span></tt>, it will create
a stack of functions (instead of just a pair).</p>
</blockquote>
<p>
<a name="fn-appendchildnodes"></a>
<a class="mochidef reference" href="#fn-appendchildnodes">appendChildNodes(node[, childNode[, ...]])</a>:</p>
<blockquote>
<p>Append children to a DOM element using the <a class="reference" href="#dom-coercion-rules">DOM Coercion Rules</a>.</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">node</span></tt>:</dt>
<dd>A reference to the DOM element to add children to
(if a string is given, <a class="mochiref reference" href="#fn-getelement">getElement(node)</a>
will be used to locate the node)</dd>
<dt><tt class="docutils literal"><span class="pre">childNode</span></tt>...:</dt>
<dd>All additional arguments, if any, will be coerced into DOM
nodes that are appended as children using the
<a class="reference" href="#dom-coercion-rules">DOM Coercion Rules</a>.</dd>
<dt><em>returns</em>:</dt>
<dd>The given DOM element</dd>
</dl>
</blockquote>
<p>
<a name="fn-computedstyle"></a>
<a class="mochidef reference" href="#fn-computedstyle">computedStyle(htmlElement, cssProperty, mozillaEquivalentCSS)</a>:</p>
<blockquote>
Looks up a CSS property for the given element. The element can be
specified as either a string with the element's ID or the element
object itself.</blockquote>
<p>
<a name="fn-createdom"></a>
<a class="mochidef reference" href="#fn-createdom">createDOM(name[, attrs[, node[, ...]]])</a>:</p>
<blockquote>
<p>Create a DOM fragment in a really convenient manner, much like
Nevow`s <a class="footnote-reference" href="#id5" id="id3" name="id3">[1]</a> stan <a class="footnote-reference" href="#id6" id="id4" name="id4">[2]</a>.</p>
<p>Partially applied versions of this function for common tags are
available as aliases:</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">A</span></tt></li>
<li><tt class="docutils literal"><span class="pre">BUTTON</span></tt></li>
<li><tt class="docutils literal"><span class="pre">BR</span></tt></li>
<li><tt class="docutils literal"><span class="pre">CANVAS</span></tt></li>
<li><tt class="docutils literal"><span class="pre">DIV</span></tt></li>
<li><tt class="docutils literal"><span class="pre">FIELDSET</span></tt></li>
<li><tt class="docutils literal"><span class="pre">FORM</span></tt></li>
<li><tt class="docutils literal"><span class="pre">H1</span></tt></li>
<li><tt class="docutils literal"><span class="pre">H2</span></tt></li>
<li><tt class="docutils literal"><span class="pre">H3</span></tt></li>
<li><tt class="docutils literal"><span class="pre">HR</span></tt></li>
<li><tt class="docutils literal"><span class="pre">IMG</span></tt></li>
<li><tt class="docutils literal"><span class="pre">INPUT</span></tt></li>
<li><tt class="docutils literal"><span class="pre">LABEL</span></tt></li>
<li><tt class="docutils literal"><span class="pre">LEGEND</span></tt></li>
<li><tt class="docutils literal"><span class="pre">LI</span></tt></li>
<li><tt class="docutils literal"><span class="pre">OL</span></tt></li>
<li><tt class="docutils literal"><span class="pre">OPTGROUP</span></tt></li>
<li><tt class="docutils literal"><span class="pre">OPTION</span></tt></li>
<li><tt class="docutils literal"><span class="pre">P</span></tt></li>
<li><tt class="docutils literal"><span class="pre">PRE</span></tt></li>
<li><tt class="docutils literal"><span class="pre">SELECT</span></tt></li>
<li><tt class="docutils literal"><span class="pre">SPAN</span></tt></li>
<li><tt class="docutils literal"><span class="pre">STRONG</span></tt></li>
<li><tt class="docutils literal"><span class="pre">TABLE</span></tt></li>
<li><tt class="docutils literal"><span class="pre">TBODY</span></tt></li>
<li><tt class="docutils literal"><span class="pre">TD</span></tt></li>
<li><tt class="docutils literal"><span class="pre">TEXTAREA</span></tt></li>
<li><tt class="docutils literal"><span class="pre">TFOOT</span></tt></li>
<li><tt class="docutils literal"><span class="pre">TH</span></tt></li>
<li><tt class="docutils literal"><span class="pre">THEAD</span></tt></li>
<li><tt class="docutils literal"><span class="pre">TR</span></tt></li>
<li><tt class="docutils literal"><span class="pre">TT</span></tt></li>
<li><tt class="docutils literal"><span class="pre">UL</span></tt></li>
</ul>
<p>See <a class="reference" href="#creating-dom-element-trees">Creating DOM Element Trees</a> for a comprehensive example.</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">name</span></tt>:</dt>
<dd>The kind of fragment to create (e.g. 'span'), such as you would
pass to <tt class="docutils literal"><span class="pre">document.createElement</span></tt>.</dd>
<dt><tt class="docutils literal"><span class="pre">attrs</span></tt>:</dt>
<dd><p class="first">An object whose properties will be used as the attributes
(e.g. <tt class="docutils literal"><span class="pre">{'style':</span> <span class="pre">'display:block'}</span></tt>), or <tt class="docutils literal"><span class="pre">null</span></tt> if no
attributes need to be set.</p>
<p>See <a class="mochiref reference" href="#fn-updatenodeattributes">updateNodeAttributes</a> for more information.</p>
<p class="last">For convenience, if <tt class="docutils literal"><span class="pre">attrs</span></tt> is a string, <tt class="docutils literal"><span class="pre">null</span></tt> is used
and the string will be considered the first <tt class="docutils literal"><span class="pre">node</span></tt>.</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">node</span></tt>...:</dt>
<dd>All additional arguments, if any, will be coerced into DOM
nodes that are appended as children using the
<a class="reference" href="#dom-coercion-rules">DOM Coercion Rules</a>.</dd>
<dt><em>returns</em>:</dt>
<dd>A DOM element</dd>
</dl>
</blockquote>
<p>
<a name="fn-createdomfunc"></a>
<a class="mochidef reference" href="#fn-createdomfunc">createDOMFunc(tag[, attrs[, node[, ...]]])</a>:</p>
<blockquote>
<p>Convenience function to create a partially applied createDOM
function. You'd want to use this if you add additional convenience
functions for creating tags, or if you find yourself creating
a lot of tags with a bunch of the same attributes or contents.</p>
<p>See <a class="mochiref reference" href="#fn-createdom">createDOM</a> for more detailed descriptions of the arguments.</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">tag</span></tt>:</dt>
<dd>The name of the tag</dd>
<dt><tt class="docutils literal"><span class="pre">attrs</span></tt>:</dt>
<dd>Optionally specify the attributes to apply</dd>
<dt><tt class="docutils literal"><span class="pre">node</span></tt>...:</dt>
<dd>Optionally specify any children nodes it should have</dd>
<dt><em>returns</em>:</dt>
<dd>function that takes additional arguments and calls
<a class="mochiref reference" href="#fn-createdom">createDOM</a></dd>
</dl>
</blockquote>
<p>
<a name="fn-currentdocument"></a>
<a class="mochidef reference" href="#fn-currentdocument">currentDocument()</a>:</p>
<blockquote>
Return the current <tt class="docutils literal"><span class="pre">document</span></tt> <a class="reference" href="#dom-context">DOM Context</a>. This will always
be the same as the global <tt class="docutils literal"><span class="pre">document</span></tt> unless <a class="mochiref reference" href="#fn-withdocument">withDocument</a> or
<a class="mochiref reference" href="#fn-withwindow">withWindow</a> is currently executing.</blockquote>
<p>
<a name="fn-currentwindow"></a>
<a class="mochidef reference" href="#fn-currentwindow">currentWindow()</a>:</p>
<blockquote>
Return the current <tt class="docutils literal"><span class="pre">window</span></tt> <a class="reference" href="#dom-context">DOM Context</a>. This will always
be the same as the global <tt class="docutils literal"><span class="pre">window</span></tt> unless <a class="mochiref reference" href="#fn-withwindow">withWindow</a> is
currently executing.</blockquote>
<p>
<a name="fn-elementdimensions"></a>
<a class="mochidef reference" href="#fn-elementdimensions">elementDimensions(element)</a>:</p>
<blockquote>
Return the absolute pixel width and height of <tt class="docutils literal"><span class="pre">element</span></tt> as an object with
<tt class="docutils literal"><span class="pre">w</span></tt> and <tt class="docutils literal"><span class="pre">h</span></tt> properties, or <tt class="docutils literal"><span class="pre">undefined</span></tt> if <tt class="docutils literal"><span class="pre">element</span></tt> is not in the
document. <tt class="docutils literal"><span class="pre">element</span></tt> may be specified as a string to be looked up with
<a class="mochiref reference" href="#fn-getelement">getElement</a>, a DOM element, or trivially as an object with
<tt class="docutils literal"><span class="pre">w</span></tt> and/or <tt class="docutils literal"><span class="pre">h</span></tt> properties.</blockquote>
<p>
<a name="fn-elementposition"></a>
<a class="mochidef reference" href="#fn-elementposition">elementPosition(element[, relativeTo={x: 0, y: 0}])</a>:</p>
<blockquote>
<p>Return the absolute pixel position of <tt class="docutils literal"><span class="pre">element</span></tt> in the document as an
object with <tt class="docutils literal"><span class="pre">x</span></tt> and <tt class="docutils literal"><span class="pre">y</span></tt> properties, or <tt class="docutils literal"><span class="pre">undefined</span></tt> if <tt class="docutils literal"><span class="pre">element</span></tt>
is not in the document. <tt class="docutils literal"><span class="pre">element</span></tt> may be specified as a string to
be looked up with <a class="mochiref reference" href="#fn-getelement">getElement</a>, a DOM element, or trivially
as an object with <tt class="docutils literal"><span class="pre">x</span></tt> and/or <tt class="docutils literal"><span class="pre">y</span></tt> properties.</p>
<p>If <tt class="docutils literal"><span class="pre">relativeTo</span></tt> is given, then its coordinates are subtracted from
the absolute position of <tt class="docutils literal"><span class="pre">element</span></tt>, e.g.:</p>
<pre class="literal-block">
var elemPos = elementPosition(elem);
var anotherElemPos = elementPosition(anotherElem);
var relPos = elementPosition(elem, anotherElem);
assert( relPos.x == (elemPos.x - anotherElemPos.x) );
assert( relPos.y == (elemPos.y - anotherElemPos.y) );
</pre>
<p><tt class="docutils literal"><span class="pre">relativeTo</span></tt> may be specified as a string to be looked up with
<a class="mochiref reference" href="#fn-getelement">getElement</a>, a DOM element, or trivially as an object
with <tt class="docutils literal"><span class="pre">x</span></tt> and/or <tt class="docutils literal"><span class="pre">y</span></tt> properties.</p>
</blockquote>
<p>
<a name="fn-emithtml"></a>
<a class="mochidef reference" href="#fn-emithtml">emitHTML(dom[, lst])</a>:</p>
<blockquote>
<p>Convert a DOM tree to an <tt class="docutils literal"><span class="pre">Array</span></tt> of HTML string fragments</p>
<p>You probably want to use <a class="mochiref reference" href="#fn-tohtml">toHTML</a> instead.</p>
</blockquote>
<p>
<a name="fn-escapehtml"></a>
<a class="mochidef reference" href="#fn-escapehtml">escapeHTML(s)</a>:</p>
<blockquote>
Make a string safe for HTML, converting the usual suspects (lt,
gt, quot, apos, amp)</blockquote>
<p>
<a name="fn-focusonload"></a>
<a class="mochidef reference" href="#fn-focusonload">focusOnLoad(element)</a>:</p>
<blockquote>
Add an onload event to focus the given element</blockquote>
<p>
<a name="fn-formcontents"></a>
<a class="mochidef reference" href="#fn-formcontents">formContents(elem)</a>:</p>
<blockquote>
Search the DOM tree, starting at <tt class="docutils literal"><span class="pre">elem</span></tt>, for any elements with a
<tt class="docutils literal"><span class="pre">name</span></tt> and <tt class="docutils literal"><span class="pre">value</span></tt> attribute. Return a 2-element <tt class="docutils literal"><span class="pre">Array</span></tt> of
<tt class="docutils literal"><span class="pre">names</span></tt> and <tt class="docutils literal"><span class="pre">values</span></tt> suitable for use with
<a class="mochiref reference" href="Base.html#fn-querystring">MochiKit.Base.queryString</a>.</blockquote>
<p>
<a name="fn-getelement"></a>
<a class="mochidef reference" href="#fn-getelement">getElement(id[, ...])</a>:</p>
<blockquote>
<p>A small quick little function to encapsulate the <tt class="docutils literal"><span class="pre">getElementById</span></tt>
method. It includes a check to ensure we can use that method.</p>
<p>If the id isn't a string, it will be returned as-is.</p>
<p>Also available as <a class="mochiref reference" href="#fn-$">$(...)</a> for convenience and compatibility with
other JavaScript frameworks.</p>
<p>If multiple arguments are given, an <tt class="docutils literal"><span class="pre">Array</span></tt> will be returned.</p>
</blockquote>
<p>
<a name="fn-getelementsbytagandclassname"></a>
<a class="mochidef reference" href="#fn-getelementsbytagandclassname">getElementsByTagAndClassName(tagName, className, parent=document)</a>:</p>
<blockquote>
<p>Returns an array of elements in <tt class="docutils literal"><span class="pre">parent</span></tt> that match the tag name
and class name provided. If <tt class="docutils literal"><span class="pre">parent</span></tt> is a string, it will be looked
up with <a class="mochiref reference" href="#fn-getelement">getElement</a>.</p>
<p>If <tt class="docutils literal"><span class="pre">tagName</span></tt> is <tt class="docutils literal"><span class="pre">null</span></tt> or <tt class="docutils literal"><span class="pre">&quot;*&quot;</span></tt>, all elements will be searched
for the matching class.</p>
<p>If <tt class="docutils literal"><span class="pre">className</span></tt> is <tt class="docutils literal"><span class="pre">null</span></tt>, all elements matching the provided tag are
returned.</p>
</blockquote>
<p>
<a name="fn-getnodeattribute"></a>
<a class="mochidef reference" href="#fn-getnodeattribute">getNodeAttribute(node, attr)</a>:</p>
<blockquote>
<p>Get the value of the given attribute for a DOM element without
ever raising an exception (will return <tt class="docutils literal"><span class="pre">null</span></tt> on exception).</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">node</span></tt>:</dt>
<dd>A reference to the DOM element to update (if a string is given,
<a class="mochiref reference" href="#fn-getelement">getElement(node)</a> will be used to locate the node)</dd>
<dt><tt class="docutils literal"><span class="pre">attr</span></tt>:</dt>
<dd><p class="first">The name of the attribute</p>
<p class="last">Note that it will do the right thing for IE, so don't do
the <tt class="docutils literal"><span class="pre">class</span></tt> -&gt; <tt class="docutils literal"><span class="pre">className</span></tt> hack yourself.</p>
</dd>
<dt><em>returns</em>:</dt>
<dd>The attribute's value, or <tt class="docutils literal"><span class="pre">null</span></tt></dd>
</dl>
</blockquote>
<p>
<a name="fn-getviewportdimensions"></a>
<a class="mochidef reference" href="#fn-getviewportdimensions">getViewportDimensions()</a>:</p>
<blockquote>
Return the pixel width and height of the viewport as an object with <tt class="docutils literal"><span class="pre">w</span></tt>
and <tt class="docutils literal"><span class="pre">h</span></tt> properties. <tt class="docutils literal"><span class="pre">element</span></tt> is looked up with
<a class="mochiref reference" href="#fn-getelement">getElement</a>, so string identifiers are also acceptable.</blockquote>
<p>
<a name="fn-haselementclass"></a>
<a class="mochidef reference" href="#fn-haselementclass">hasElementClass(element, className[, ...])</a>:</p>
<blockquote>
Return <tt class="docutils literal"><span class="pre">true</span></tt> if <tt class="docutils literal"><span class="pre">className</span></tt> is found on the <tt class="docutils literal"><span class="pre">element</span></tt>.
<tt class="docutils literal"><span class="pre">element</span></tt> is looked up with <a class="mochiref reference" href="#fn-getelement">getElement</a>, so string identifiers
are also acceptable.</blockquote>
<p>
<a name="fn-hideelement"></a>
<a class="mochidef reference" href="#fn-hideelement">hideElement(element, ...)</a>:</p>
<blockquote>
<p>Partial form of <a class="mochiref reference" href="#fn-setdisplayforelement">setDisplayForElement</a>, specifically:</p>
<pre class="literal-block">
partial(setDisplayForElement, &quot;none&quot;)
</pre>
<p>For information about the caveats of using a <tt class="docutils literal"><span class="pre">style.display</span></tt> based
show/hide mechanism, and a CSS based alternative, see
<a class="reference" href="#element-visibility">Element Visibility</a>.</p>
</blockquote>
<p>
<a name="fn-registerdomconverter"></a>
<a class="mochidef reference" href="#fn-registerdomconverter">registerDOMConverter(name, check, wrap[, override])</a>:</p>
<blockquote>
Register an adapter to convert objects that match <tt class="docutils literal"><span class="pre">check(obj,</span> <span class="pre">ctx)</span></tt>
to a DOM element, or something that can be converted to a DOM
element (i.e. number, bool, string, function, iterable).</blockquote>
<p>
<a name="fn-removeelement"></a>
<a class="mochidef reference" href="#fn-removeelement">removeElement(node)</a>:</p>
<blockquote>
<p>Remove and return <tt class="docutils literal"><span class="pre">node</span></tt> from a DOM tree. This is technically
just a convenience for <a class="mochiref reference" href="#fn-swapdom">swapDOM(node, null)</a>.</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">node</span></tt>:</dt>
<dd>the DOM element (or string id of one) to be removed</dd>
<dt><em>returns</em></dt>
<dd>The removed element</dd>
</dl>
</blockquote>
<p>
<a name="fn-removeelementclass"></a>
<a class="mochidef reference" href="#fn-removeelementclass">removeElementClass(element, className)</a>:</p>
<blockquote>
Ensure that the given <tt class="docutils literal"><span class="pre">element</span></tt> does not have <tt class="docutils literal"><span class="pre">className</span></tt> set as part
of its class attribute. This will not disturb other class names.
<tt class="docutils literal"><span class="pre">element</span></tt> is looked up with <a class="mochiref reference" href="#fn-getelement">getElement</a>, so string identifiers
are also acceptable.</blockquote>
<p>
<a name="fn-replacechildnodes"></a>
<a class="mochidef reference" href="#fn-replacechildnodes">replaceChildNodes(node[, childNode[, ...]])</a>:</p>
<blockquote>
<p>Remove all children from the given DOM element, then append any given
childNodes to it (by calling <a class="mochiref reference" href="#fn-appendchildnodes">appendChildNodes</a>).</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">node</span></tt>:</dt>
<dd>A reference to the DOM element to add children to
(if a string is given, <a class="mochiref reference" href="#fn-getelement">getElement(node)</a>
will be used to locate the node)</dd>
<dt><tt class="docutils literal"><span class="pre">childNode</span></tt>...:</dt>
<dd>All additional arguments, if any, will be coerced into DOM
nodes that are appended as children using the
<a class="reference" href="#dom-coercion-rules">DOM Coercion Rules</a>.</dd>
<dt><em>returns</em>:</dt>
<dd>The given DOM element</dd>
</dl>
</blockquote>
<p>
<a name="fn-scrapetext"></a>
<a class="mochidef reference" href="#fn-scrapetext">scrapeText(node[, asArray=false])</a>:</p>
<blockquote>
<p>Walk a DOM tree in-order and scrape all of the text out of it as a
<tt class="docutils literal"><span class="pre">string</span></tt>.</p>
<p>If <tt class="docutils literal"><span class="pre">asArray</span></tt> is <tt class="docutils literal"><span class="pre">true</span></tt>, then an <tt class="docutils literal"><span class="pre">Array</span></tt> will be returned with
each individual text node. These two are equivalent:</p>
<pre class="literal-block">
assert( scrapeText(node) == scrapeText(node, true).join(&quot;&quot;) );
</pre>
</blockquote>
<p>
<a name="fn-setdisplayforelement"></a>
<a class="mochidef reference" href="#fn-setdisplayforelement">setDisplayForElement(display, element[, ...])</a>:</p>
<blockquote>
<p>Change the <tt class="docutils literal"><span class="pre">style.display</span></tt> for the given element(s). Usually
used as the partial forms:</p>
<ul class="simple">
<li><a class="mochiref reference" href="#fn-showelement">showElement(element, ...)</a></li>
<li><a class="mochiref reference" href="#fn-hideelement">hideElement(element, ...)</a></li>
</ul>
<p>Elements are looked up with <a class="mochiref reference" href="#fn-getelement">getElement</a>, so string identifiers
are acceptable.</p>
<p>For information about the caveats of using a <tt class="docutils literal"><span class="pre">style.display</span></tt> based
show/hide mechanism, and a CSS based alternative, see
<a class="reference" href="#element-visibility">Element Visibility</a>.</p>
</blockquote>
<p>
<a name="fn-setelementclass"></a>
<a class="mochidef reference" href="#fn-setelementclass">setElementClass(element, className)</a>:</p>
<blockquote>
Set the entire class attribute of <tt class="docutils literal"><span class="pre">element</span></tt> to <tt class="docutils literal"><span class="pre">className</span></tt>.
<tt class="docutils literal"><span class="pre">element</span></tt> is looked up with <a class="mochiref reference" href="#fn-getelement">getElement</a>, so string identifiers
are also acceptable.</blockquote>
<p>
<a name="fn-setelementdimensions"></a>
<a class="mochidef reference" href="#fn-setelementdimensions">setElementDimensions(element, dimensions[, units='px'])</a>:</p>
<blockquote>
<p>Sets the dimensions of <tt class="docutils literal"><span class="pre">element</span></tt> in the document from an
object with <tt class="docutils literal"><span class="pre">w</span></tt> and <tt class="docutils literal"><span class="pre">h</span></tt> properties.</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">node</span></tt>:</dt>
<dd>A reference to the DOM element to update (if a string is given,
<a class="mochiref reference" href="#fn-getelement">getElement(node)</a> will be used to locate the node)</dd>
<dt><tt class="docutils literal"><span class="pre">dimensions</span></tt>:</dt>
<dd>An object with <tt class="docutils literal"><span class="pre">w</span></tt> and <tt class="docutils literal"><span class="pre">h</span></tt> properties</dd>
<dt><tt class="docutils literal"><span class="pre">units</span></tt>:</dt>
<dd>Optionally set the units to use, default is <tt class="docutils literal"><span class="pre">px</span></tt></dd>
</dl>
</blockquote>
<p>
<a name="fn-setelementposition"></a>
<a class="mochidef reference" href="#fn-setelementposition">setElementPosition(element, position[, units='px'])</a>:</p>
<blockquote>
<p>Sets the absolute position of <tt class="docutils literal"><span class="pre">element</span></tt> in the document from an
object with <tt class="docutils literal"><span class="pre">x</span></tt> and <tt class="docutils literal"><span class="pre">y</span></tt> properties.</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">node</span></tt>:</dt>
<dd>A reference to the DOM element to update (if a string is given,
<a class="mochiref reference" href="#fn-getelement">getElement(node)</a> will be used to locate the node)</dd>
<dt><tt class="docutils literal"><span class="pre">position</span></tt>:</dt>
<dd>An object with <tt class="docutils literal"><span class="pre">x</span></tt> and <tt class="docutils literal"><span class="pre">y</span></tt> properties</dd>
<dt><tt class="docutils literal"><span class="pre">units</span></tt>:</dt>
<dd>Optionally set the units to use, default is <tt class="docutils literal"><span class="pre">px</span></tt></dd>
</dl>
</blockquote>
<p>
<a name="fn-setnodeattribute"></a>
<a class="mochidef reference" href="#fn-setnodeattribute">setNodeAttribute(node, attr, value)</a>:</p>
<blockquote>
<p>Set the value of the given attribute for a DOM element without
ever raising an exception (will return null on exception). If
setting more than one attribute, you should use
<a class="mochiref reference" href="#fn-updatenodeattributes">updateNodeAttributes</a>.</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">node</span></tt>:</dt>
<dd>A reference to the DOM element to update (if a string is given,
<a class="mochiref reference" href="#fn-getelement">getElement(node)</a> will be used to locate the node)</dd>
<dt><tt class="docutils literal"><span class="pre">attr</span></tt>:</dt>
<dd><p class="first">The name of the attribute</p>
<p class="last">Note that it will do the right thing for IE, so don't do
the <tt class="docutils literal"><span class="pre">class</span></tt> -&gt; <tt class="docutils literal"><span class="pre">className</span></tt> hack yourself.</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">value</span></tt>:</dt>
<dd>The value of the attribute, may be an object to be merged
(e.g. for setting style).</dd>
<dt><em>returns</em>:</dt>
<dd>The given DOM element or <tt class="docutils literal"><span class="pre">null</span></tt> on failure</dd>
</dl>
</blockquote>
<p>
<a name="fn-setopacity"></a>
<a class="mochidef reference" href="#fn-setopacity">setOpacity(element, opacity)</a>:</p>
<blockquote>
Sets <tt class="docutils literal"><span class="pre">opacity</span></tt> for <tt class="docutils literal"><span class="pre">element</span></tt>. Valid <tt class="docutils literal"><span class="pre">opacity</span></tt> values range from 0
(invisible) to 1 (opaque). <tt class="docutils literal"><span class="pre">element</span></tt> is looked up with
<a class="mochiref reference" href="#fn-getelement">getElement</a>, so string identifiers are also acceptable.</blockquote>
<p>
<a name="fn-showelement"></a>
<a class="mochidef reference" href="#fn-showelement">showElement(element, ...)</a>:</p>
<blockquote>
<p>Partial form of <a class="mochiref reference" href="#fn-setdisplayforelement">setDisplayForElement</a>, specifically:</p>
<pre class="literal-block">
partial(setDisplayForElement, &quot;block&quot;)
</pre>
<p>For information about the caveats of using a <tt class="docutils literal"><span class="pre">style.display</span></tt> based
show/hide mechanism, and a CSS based alternative, see
<a class="reference" href="#element-visibility">Element Visibility</a>.</p>
</blockquote>
<p>
<a name="fn-swapdom"></a>
<a class="mochidef reference" href="#fn-swapdom">swapDOM(dest, src)</a>:</p>
<blockquote>
<p>Replace <tt class="docutils literal"><span class="pre">dest</span></tt> in a DOM tree with <tt class="docutils literal"><span class="pre">src</span></tt>, returning <tt class="docutils literal"><span class="pre">src</span></tt>.</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">dest</span></tt>:</dt>
<dd>a DOM element (or string id of one) to be replaced</dd>
<dt><tt class="docutils literal"><span class="pre">src</span></tt>:</dt>
<dd>the DOM element (or string id of one) to replace it with, or
<tt class="docutils literal"><span class="pre">null</span></tt> if <tt class="docutils literal"><span class="pre">dest</span></tt> is to be removed (replaced with nothing).</dd>
<dt><em>returns</em>:</dt>
<dd>a DOM element (<tt class="docutils literal"><span class="pre">src</span></tt>)</dd>
</dl>
</blockquote>
<p>
<a name="fn-swapelementclass"></a>
<a class="mochidef reference" href="#fn-swapelementclass">swapElementClass(element, fromClass, toClass)</a>:</p>
<blockquote>
If <tt class="docutils literal"><span class="pre">fromClass</span></tt> is set on <tt class="docutils literal"><span class="pre">element</span></tt>, replace it with <tt class="docutils literal"><span class="pre">toClass</span></tt>.
This will not disturb other classes on that element.
<tt class="docutils literal"><span class="pre">element</span></tt> is looked up with <a class="mochiref reference" href="#fn-getelement">getElement</a>, so string identifiers
are also acceptable.</blockquote>
<p>
<a name="fn-toggleelementclass"></a>
<a class="mochidef reference" href="#fn-toggleelementclass">toggleElementClass(className[, element[, ...]])</a>:</p>
<blockquote>
Toggle the presence of a given <tt class="docutils literal"><span class="pre">className</span></tt> in the class attribute
of all given elements. All elements will be looked up with
<a class="mochiref reference" href="#fn-getelement">getElement</a>, so string identifiers are acceptable.</blockquote>
<p>
<a name="fn-tohtml"></a>
<a class="mochidef reference" href="#fn-tohtml">toHTML(dom)</a>:</p>
<blockquote>
Convert a DOM tree to a HTML string using <a class="mochiref reference" href="#fn-emithtml">emitHTML</a></blockquote>
<p>
<a name="fn-updatenodeattributes"></a>
<a class="mochidef reference" href="#fn-updatenodeattributes">updateNodeAttributes(node, attrs)</a>:</p>
<blockquote>
<p>Update the attributes of a DOM element from a given object.</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">node</span></tt>:</dt>
<dd>A reference to the DOM element to update (if a string is given,
<a class="mochiref reference" href="#fn-getelement">getElement(node)</a> will be used to locate the node)</dd>
<dt><tt class="docutils literal"><span class="pre">attrs</span></tt>:</dt>
<dd><p class="first">An object whose properties will be used to set the attributes
(e.g. <tt class="docutils literal"><span class="pre">{'class':</span> <span class="pre">'invisible'}</span></tt>), or <tt class="docutils literal"><span class="pre">null</span></tt> if no
attributes need to be set. If an object is given for the
attribute value (e.g. <tt class="docutils literal"><span class="pre">{'style':</span> <span class="pre">{'display':</span> <span class="pre">'block'}}</span></tt>)
then <a class="mochiref reference" href="Base.html#fn-updatetree">MochiKit.Base.updatetree</a> will be used to set that
attribute.</p>
<p class="last">Note that it will do the right thing for IE, so don't do
the <tt class="docutils literal"><span class="pre">class</span></tt> -&gt; <tt class="docutils literal"><span class="pre">className</span></tt> hack yourself, and it deals with
setting &quot;on...&quot; event handlers correctly.</p>
</dd>
<dt><em>returns</em>:</dt>
<dd>The given DOM element</dd>
</dl>
</blockquote>
<p>
<a name="fn-withwindow"></a>
<a class="mochidef reference" href="#fn-withwindow">withWindow(win, func)</a>:</p>
<blockquote>
<p>Call <tt class="docutils literal"><span class="pre">func</span></tt> with the <tt class="docutils literal"><span class="pre">window</span></tt> <a class="reference" href="#dom-context">DOM Context</a> set to <tt class="docutils literal"><span class="pre">win</span></tt> and
the <tt class="docutils literal"><span class="pre">document</span></tt> <a class="reference" href="#dom-context">DOM Context</a> set to <tt class="docutils literal"><span class="pre">win.document</span></tt>. When
<tt class="docutils literal"><span class="pre">func()</span></tt> returns or throws an error, the <a class="reference" href="#dom-context">DOM Context</a> will be
restored to its previous state.</p>
<p>The return value of <tt class="docutils literal"><span class="pre">func()</span></tt> is returned by this function.</p>
</blockquote>
<p>
<a name="fn-withdocument"></a>
<a class="mochidef reference" href="#fn-withdocument">withDocument(doc, func)</a>:</p>
<blockquote>
<p>Call <tt class="docutils literal"><span class="pre">func</span></tt> with the <tt class="docutils literal"><span class="pre">doc</span></tt> <a class="reference" href="#dom-context">DOM Context</a> set to <tt class="docutils literal"><span class="pre">doc</span></tt>.
When <tt class="docutils literal"><span class="pre">func()</span></tt> returns or throws an error, the <a class="reference" href="#dom-context">DOM Context</a>
will be restored to its previous state.</p>
<p>The return value of <tt class="docutils literal"><span class="pre">func()</span></tt> is returned by this function.</p>
</blockquote>
</div>
</div>
<div class="section">
<h1><a id="see-also" name="see-also">See Also</a></h1>
<table class="docutils footnote" frame="void" id="id5" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a name="id5">[1]</a></td><td><em>(<a class="fn-backref" href="#id1">1</a>, <a class="fn-backref" href="#id3">2</a>)</em> Nevow, a web application construction kit for Python: <a class="reference" href="http://nevow.com/">http://nevow.com/</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id6" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a name="id6">[2]</a></td><td><em>(<a class="fn-backref" href="#id2">1</a>, <a class="fn-backref" href="#id4">2</a>)</em> nevow.stan is a domain specific language for Python
(read as &quot;crazy getitem/call overloading abuse&quot;) that Donovan and I
schemed up at PyCon 2003 at this super ninja Python/C++ programmer's
(David Abrahams) hotel room. Donovan later inflicted this upon the
masses in Nevow. Check out the Divmod project page for some
examples: <a class="reference" href="http://nevow.com/Nevow2004Tutorial.html">http://nevow.com/Nevow2004Tutorial.html</a></td></tr>
</tbody>
</table>
</div>
<div class="section">
<h1><a id="authors" name="authors">Authors</a></h1>
<ul class="simple">
<li>Bob Ippolito &lt;<a class="reference" href="mailto:bob&#64;redivi.com">bob&#64;redivi.com</a>&gt;</li>
</ul>
</div>
<div class="section">
<h1><a id="copyright" name="copyright">Copyright</a></h1>
<p>Copyright 2005 Bob Ippolito &lt;<a class="reference" href="mailto:bob&#64;redivi.com">bob&#64;redivi.com</a>&gt;. This program is dual-licensed
free software; you can redistribute it and/or modify it under the terms of the
<a class="reference" href="http://www.opensource.org/licenses/mit-license.php">MIT License</a> or the <a class="reference" href="http://www.opensource.org/licenses/afl-2.1.php">Academic Free License v2.1</a>.</p>
</div>
</div>
</body>
</html>

View File

@@ -1,125 +0,0 @@
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
<title>MochiKit.DateTime - &quot;what time is it anyway?&quot;</title>
<link rel="stylesheet" href="../../../include/css/documentation.css" type="text/css" />
<script type="text/javascript" src="../../../packed/lib/MochiKit/MochiKit.js"></script>
<script type="text/javascript" src="../../js/toc.js"></script>
</head>
<body>
<div class="document">
<div class="section">
<h1><a id="name" name="name">Name</a></h1>
<p>MochiKit.DateTime - &quot;what time is it anyway?&quot;</p>
</div>
<div class="section">
<h1><a id="synopsis" name="synopsis">Synopsis</a></h1>
<pre class="literal-block">
stringDate = toISOTimestamp(new Date());
dateObject = isoTimestamp(stringDate);
</pre>
</div>
<div class="section">
<h1><a id="description" name="description">Description</a></h1>
<p>Remote servers don't give you JavaScript Date objects, and they certainly
don't want them from you, so you need to deal with string representations
of dates and timestamps. MochiKit.Date does that.</p>
</div>
<div class="section">
<h1><a id="dependencies" name="dependencies">Dependencies</a></h1>
<p>None.</p>
</div>
<div class="section">
<h1><a id="api-reference" name="api-reference">API Reference</a></h1>
<div class="section">
<h2><a id="functions" name="functions">Functions</a></h2>
<p>
<a name="fn-isodate"></a>
<a class="mochidef reference" href="#fn-isodate">isoDate(str)</a>:</p>
<blockquote>
Convert an ISO 8601 date (YYYY-MM-DD) to a <tt class="docutils literal"><span class="pre">Date</span></tt> object.</blockquote>
<p>
<a name="fn-isotimestamp"></a>
<a class="mochidef reference" href="#fn-isotimestamp">isoTimestamp(str)</a>:</p>
<blockquote>
<p>Convert any ISO 8601 <a class="footnote-reference" href="#id3" id="id1" name="id1">[1]</a> timestamp (or something reasonably close to it)
to a <tt class="docutils literal"><span class="pre">Date</span></tt> object. Will accept the &quot;de facto&quot; form:</p>
<blockquote>
YYYY-MM-DD hh:mm:ss</blockquote>
<p>or (the proper form):</p>
<blockquote>
YYYY-MM-DDThh:mm:ssZ</blockquote>
<p>If a time zone designator (&quot;Z&quot; or &quot;[+-]HH:MM&quot;) is not present, then the
local timezone is used.</p>
</blockquote>
<p>
<a name="fn-toisotime"></a>
<a class="mochidef reference" href="#fn-toisotime">toISOTime(date)</a>:</p>
<blockquote>
Convert a <tt class="docutils literal"><span class="pre">Date</span></tt> object to a string in the form of hh:mm:ss</blockquote>
<p>
<a name="fn-toisotimestamp"></a>
<a class="mochidef reference" href="#fn-toisotimestamp">toISOTimestamp(date, realISO=false)</a>:</p>
<blockquote>
<p>Convert a <tt class="docutils literal"><span class="pre">Date</span></tt> object to something that's ALMOST but not quite an
ISO 8601 [1]_timestamp. If it was a proper ISO timestamp it would be:</p>
<blockquote>
YYYY-MM-DDThh:mm:ssZ</blockquote>
<p>However, we see junk in SQL and other places that looks like this:</p>
<blockquote>
YYYY-MM-DD hh:mm:ss</blockquote>
<p>So, this function returns the latter form, despite its name, unless
you pass <tt class="docutils literal"><span class="pre">true</span></tt> for <tt class="docutils literal"><span class="pre">realISO</span></tt>.</p>
</blockquote>
<p>
<a name="fn-toisodate"></a>
<a class="mochidef reference" href="#fn-toisodate">toISODate(date)</a>:</p>
<blockquote>
Convert a <tt class="docutils literal"><span class="pre">Date</span></tt> object to an ISO 8601 <a class="footnote-reference" href="#id3" id="id2" name="id2">[1]</a> date string (YYYY-MM-DD)</blockquote>
<p>
<a name="fn-americandate"></a>
<a class="mochidef reference" href="#fn-americandate">americanDate(str)</a>:</p>
<blockquote>
Converts a MM/DD/YYYY date to a <tt class="docutils literal"><span class="pre">Date</span></tt> object</blockquote>
<p>
<a name="fn-topaddedamericandate"></a>
<a class="mochidef reference" href="#fn-topaddedamericandate">toPaddedAmericanDate(date)</a>:</p>
<blockquote>
Converts a <tt class="docutils literal"><span class="pre">Date</span></tt> object to an MM/DD/YYYY date, e.g. 01/01/2001</blockquote>
<p>
<a name="fn-toamericandate"></a>
<a class="mochidef reference" href="#fn-toamericandate">toAmericanDate(date)</a>:</p>
<blockquote>
Converts a <tt class="docutils literal"><span class="pre">Date</span></tt> object to an M/D/YYYY date, e.g. 1/1/2001</blockquote>
</div>
</div>
<div class="section">
<h1><a id="see-also" name="see-also">See Also</a></h1>
<table class="docutils footnote" frame="void" id="id3" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a name="id3">[1]</a></td><td><em>(<a class="fn-backref" href="#id1">1</a>, <a class="fn-backref" href="#id2">2</a>)</em> W3C profile of ISO 8601: <a class="reference" href="http://www.w3.org/TR/NOTE-datetime">http://www.w3.org/TR/NOTE-datetime</a></td></tr>
</tbody>
</table>
</div>
<div class="section">
<h1><a id="authors" name="authors">Authors</a></h1>
<ul class="simple">
<li>Bob Ippolito &lt;<a class="reference" href="mailto:bob&#64;redivi.com">bob&#64;redivi.com</a>&gt;</li>
</ul>
</div>
<div class="section">
<h1><a id="copyright" name="copyright">Copyright</a></h1>
<p>Copyright 2005 Bob Ippolito &lt;<a class="reference" href="mailto:bob&#64;redivi.com">bob&#64;redivi.com</a>&gt;. This program is dual-licensed
free software; you can redistribute it and/or modify it under the terms of the
<a class="reference" href="http://www.opensource.org/licenses/mit-license.php">MIT License</a> or the <a class="reference" href="http://www.opensource.org/licenses/afl-2.1.php">Academic Free License v2.1</a>.</p>
</div>
</div>
</body>
</html>

View File

@@ -1,241 +0,0 @@
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
<title>MochiKit.Format - string formatting goes here</title>
<link rel="stylesheet" href="../../../include/css/documentation.css" type="text/css" />
<script type="text/javascript" src="../../../packed/lib/MochiKit/MochiKit.js"></script>
<script type="text/javascript" src="../../js/toc.js"></script>
</head>
<body>
<div class="document">
<div class="section">
<h1><a id="name" name="name">Name</a></h1>
<p>MochiKit.Format - string formatting goes here</p>
</div>
<div class="section">
<h1><a id="synopsis" name="synopsis">Synopsis</a></h1>
<pre class="literal-block">
assert( truncToFixed(0.12345, 4) == &quot;0.1234&quot; );
assert( roundToFixed(0.12345, 4) == &quot;0.1235&quot; );
assert( twoDigitAverage(1, 0) == &quot;0&quot; );
assert( twoDigitFloat(1.2345) == &quot;1.23&quot; );
assert( twoDigitFloat(1) == &quot;1&quot; );
assert( percentFormat(1.234567) == &quot;123.46%&quot; );
assert( numberFormatter(&quot;###,###%&quot;)(125) == &quot;12,500%&quot; );
assert( numberFormatter(&quot;##.000&quot;)(1.25) == &quot;1.250&quot; );
</pre>
</div>
<div class="section">
<h1><a id="description" name="description">Description</a></h1>
<p>Formatting strings and stringifying numbers is boring, so a couple useful
functions in that domain live here.</p>
</div>
<div class="section">
<h1><a id="dependencies" name="dependencies">Dependencies</a></h1>
<p>None.</p>
</div>
<div class="section">
<h1><a id="overview" name="overview">Overview</a></h1>
<div class="section">
<h2><a id="formatting-numbers" name="formatting-numbers">Formatting Numbers</a></h2>
<p>MochiKit provides an extensible number formatting facility, modeled loosely
after the Number Format Pattern Syntax <a class="footnote-reference" href="#id2" id="id1" name="id1">[1]</a> from Java.
<a class="mochiref reference" href="#fn-numberformatter">numberFormatter(pattern[, placeholder=&quot;&quot;[, locale=&quot;default&quot;])</a>
returns a function that converts Number to string using the given information.
<tt class="docutils literal"><span class="pre">pattern</span></tt> is a string consisting of the following symbols:</p>
<table border="1" class="docutils">
<colgroup>
<col width="15%" />
<col width="85%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">Symbol</th>
<th class="head">Meaning</th>
</tr>
</thead>
<tbody valign="top">
<tr><td><tt class="docutils literal"><span class="pre">-</span></tt></td>
<td>If given, used as the position of the minus sign
for negative numbers. If not given, the position
to the left of the first number placeholder is used.</td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">#</span></tt></td>
<td>The placeholder for a number that does not imply zero
padding.</td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">0</span></tt></td>
<td>The placeholder for a number that implies zero padding.
If it is used to the right of a decimal separator, it
implies trailing zeros, otherwise leading zeros.</td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">,</span></tt></td>
<td>The placeholder for a &quot;thousands separator&quot;. May be used
at most once, and it must be to the left of a decimal
separator. Will be replaced by <tt class="docutils literal"><span class="pre">locale.separator</span></tt> in the
result (the default is also <tt class="docutils literal"><span class="pre">,</span></tt>).</td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">.</span></tt></td>
<td>The decimal separator. The quantity of <tt class="docutils literal"><span class="pre">#</span></tt> or <tt class="docutils literal"><span class="pre">0</span></tt>
after the decimal separator will determine the precision of
the result. If no decimal separator is present, the
fractional precision is <tt class="docutils literal"><span class="pre">0</span></tt> -- meaning that it will be
rounded to the nearest integer.</td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">%</span></tt></td>
<td>If present, the number will be multiplied by <tt class="docutils literal"><span class="pre">100</span></tt> and
the <tt class="docutils literal"><span class="pre">%</span></tt> will be replaced by <tt class="docutils literal"><span class="pre">locale.percent</span></tt>.</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section">
<h1><a id="api-reference" name="api-reference">API Reference</a></h1>
<div class="section">
<h2><a id="functions" name="functions">Functions</a></h2>
<p>
<a name="fn-formatlocale"></a>
<a class="mochidef reference" href="#fn-formatlocale">formatLocale(locale=&quot;default&quot;)</a>:</p>
<blockquote>
Return a locale object for the given locale. <tt class="docutils literal"><span class="pre">locale</span></tt> may be either a
string, which is looked up in the <tt class="docutils literal"><span class="pre">MochiKit.Format.LOCALE</span></tt> object, or
a locale object. If no locale is given, <tt class="docutils literal"><span class="pre">LOCALE.default</span></tt> is used
(equivalent to <tt class="docutils literal"><span class="pre">LOCALE.en_US</span></tt>).</blockquote>
<p>
<a name="fn-lstrip"></a>
<a class="mochidef reference" href="#fn-lstrip">lstrip(str, chars=&quot;\s&quot;)</a>:</p>
<blockquote>
<p>Returns a string based on <tt class="docutils literal"><span class="pre">str</span></tt> with leading whitespace stripped.</p>
<p>If <tt class="docutils literal"><span class="pre">chars</span></tt> is given, then that expression will be used instead of
whitespace. <tt class="docutils literal"><span class="pre">chars</span></tt> should be a string suitable for use in a <tt class="docutils literal"><span class="pre">RegExp</span></tt>
<tt class="docutils literal"><span class="pre">[character</span> <span class="pre">set]</span></tt>.</p>
</blockquote>
<p>
<a name="fn-numberformatter"></a>
<a class="mochidef reference" href="#fn-numberformatter">numberFormatter(pattern, placeholder=&quot;&quot;, locale=&quot;default&quot;)</a>:</p>
<blockquote>
<p>Return a function <tt class="docutils literal"><span class="pre">formatNumber(aNumber)</span></tt> that formats numbers
as a string according to the given pattern, placeholder and locale.</p>
<p><tt class="docutils literal"><span class="pre">pattern</span></tt> is a string that describes how the numbers should be formatted,
for more information see <a class="reference" href="#formatting-numbers">Formatting Numbers</a>.</p>
<p><tt class="docutils literal"><span class="pre">locale</span></tt> is a string of a known locale (en_US, de_DE, fr_FR, default) or
an object with the following fields:</p>
<table border="1" class="docutils">
<colgroup>
<col width="16%" />
<col width="84%" />
</colgroup>
<tbody valign="top">
<tr><td>separator</td>
<td>The &quot;thousands&quot; separator for this locale (en_US is &quot;,&quot;)</td>
</tr>
<tr><td>decimal</td>
<td>The decimal separator for this locale (en_US is &quot;.&quot;)</td>
</tr>
<tr><td>percent</td>
<td>The percent symbol for this locale (en_US is &quot;%&quot;)</td>
</tr>
</tbody>
</table>
</blockquote>
<p>
<a name="fn-percentformat"></a>
<a class="mochidef reference" href="#fn-percentformat">percentFormat(someFloat)</a>:</p>
<blockquote>
<p>Roughly equivalent to: <tt class="docutils literal"><span class="pre">sprintf(&quot;%.2f%%&quot;,</span> <span class="pre">someFloat</span> <span class="pre">*</span> <span class="pre">100)</span></tt></p>
<p>In new code, you probably want to use:
<a class="mochiref reference" href="#fn-numberformatter">numberFormatter(&quot;#.##%&quot;)(someFloat)</a> instead.</p>
</blockquote>
<p>
<a name="fn-roundtofixed"></a>
<a class="mochidef reference" href="#fn-roundtofixed">roundToFixed(aNumber, precision)</a>:</p>
<blockquote>
<p>Return a string representation of <tt class="docutils literal"><span class="pre">aNumber</span></tt>, rounded to <tt class="docutils literal"><span class="pre">precision</span></tt>
digits with trailing zeros. This is similar to
<tt class="docutils literal"><span class="pre">Number.toFixed(aNumber,</span> <span class="pre">precision)</span></tt>, but this has implementation
consistent rounding behavior (some versions of Safari round 0.5 down!)
and also includes preceding <tt class="docutils literal"><span class="pre">0</span></tt> for numbers less than <tt class="docutils literal"><span class="pre">1</span></tt> (Safari,
again).</p>
<p>For example, <a class="mochiref reference" href="#fn-roundtofixed">roundToFixed(0.1357, 2)</a> returns <tt class="docutils literal"><span class="pre">0.14</span></tt> on every
supported platform, where some return <tt class="docutils literal"><span class="pre">.13</span></tt> for <tt class="docutils literal"><span class="pre">(0.1357).toFixed(2)</span></tt>.</p>
</blockquote>
<p>
<a name="fn-rstrip"></a>
<a class="mochidef reference" href="#fn-rstrip">rstrip(str, chars=&quot;\s&quot;)</a>:</p>
<blockquote>
<p>Returns a string based on <tt class="docutils literal"><span class="pre">str</span></tt> with trailing whitespace stripped.</p>
<p>If <tt class="docutils literal"><span class="pre">chars</span></tt> is given, then that expression will be used instead of
whitespace. <tt class="docutils literal"><span class="pre">chars</span></tt> should be a string suitable for use in a <tt class="docutils literal"><span class="pre">RegExp</span></tt>
<tt class="docutils literal"><span class="pre">[character</span> <span class="pre">set]</span></tt>.</p>
</blockquote>
<p>
<a name="fn-strip"></a>
<a class="mochidef reference" href="#fn-strip">strip(str, chars=&quot;\s&quot;)</a>:</p>
<blockquote>
<p>Returns a string based on <tt class="docutils literal"><span class="pre">str</span></tt> with leading and trailing whitespace
stripped (equivalent to <a class="mochiref reference" href="#fn-lstrip">lstrip(rstrip(str, chars), chars)</a>).</p>
<p>If <tt class="docutils literal"><span class="pre">chars</span></tt> is given, then that expression will be used instead of
whitespace. <tt class="docutils literal"><span class="pre">chars</span></tt> should be a string suitable for use in a <tt class="docutils literal"><span class="pre">RegExp</span></tt>
<tt class="docutils literal"><span class="pre">[character</span> <span class="pre">set]</span></tt>.</p>
</blockquote>
<p>
<a name="fn-trunctofixed"></a>
<a class="mochidef reference" href="#fn-trunctofixed">truncToFixed(aNumber, precision)</a>:</p>
<blockquote>
<p>Return a string representation of <tt class="docutils literal"><span class="pre">aNumber</span></tt>, truncated to <tt class="docutils literal"><span class="pre">precision</span></tt>
digits with trailing zeros. This is similar to
<tt class="docutils literal"><span class="pre">aNumber.toFixed(precision)</span></tt>, but this truncates rather than rounds and
has implementation consistent behavior for numbers less than 1.
Specifically, <a class="mochiref reference" href="#fn-trunctofixed">truncToFixed(aNumber, precision)</a> will always have a
preceding <tt class="docutils literal"><span class="pre">0</span></tt> for numbers less than <tt class="docutils literal"><span class="pre">1</span></tt>.</p>
<p>For example, <a class="mochiref reference" href="#fn-tofixed">toFixed(0.1357, 2)</a> returns <tt class="docutils literal"><span class="pre">0.13</span></tt>.</p>
</blockquote>
<p>
<a name="fn-twodigitaverage"></a>
<a class="mochidef reference" href="#fn-twodigitaverage">twoDigitAverage(numerator, denominator)</a>:</p>
<blockquote>
<p>Calculate an average from a numerator and a denominator and return
it as a string with two digits of precision (e.g. &quot;1.23&quot;).</p>
<p>If the denominator is 0, &quot;0&quot; will be returned instead of <tt class="docutils literal"><span class="pre">NaN</span></tt>.</p>
</blockquote>
<p>
<a name="fn-twodigitfloat"></a>
<a class="mochidef reference" href="#fn-twodigitfloat">twoDigitFloat(someFloat)</a>:</p>
<blockquote>
<p>Roughly equivalent to: <tt class="docutils literal"><span class="pre">sprintf(&quot;%.2f&quot;,</span> <span class="pre">someFloat)</span></tt></p>
<p>In new code, you probably want to use
<a class="mochiref reference" href="#fn-numberformatter">numberFormatter(&quot;#.##&quot;)(someFloat)</a> instead.</p>
</blockquote>
</div>
</div>
<div class="section">
<h1><a id="see-also" name="see-also">See Also</a></h1>
<table class="docutils footnote" frame="void" id="id2" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id1" name="id2">[1]</a></td><td>Java Number Format Pattern Syntax:
<a class="reference" href="http://java.sun.com/docs/books/tutorial/i18n/format/numberpattern.html">http://java.sun.com/docs/books/tutorial/i18n/format/numberpattern.html</a></td></tr>
</tbody>
</table>
</div>
<div class="section">
<h1><a id="authors" name="authors">Authors</a></h1>
<ul class="simple">
<li>Bob Ippolito &lt;<a class="reference" href="mailto:bob&#64;redivi.com">bob&#64;redivi.com</a>&gt;</li>
</ul>
</div>
<div class="section">
<h1><a id="copyright" name="copyright">Copyright</a></h1>
<p>Copyright 2005 Bob Ippolito &lt;<a class="reference" href="mailto:bob&#64;redivi.com">bob&#64;redivi.com</a>&gt;. This program is dual-licensed
free software; you can redistribute it and/or modify it under the terms of the
<a class="reference" href="http://www.opensource.org/licenses/mit-license.php">MIT License</a> or the <a class="reference" href="http://www.opensource.org/licenses/afl-2.1.php">Academic Free License v2.1</a>.</p>
</div>
</div>
</body>
</html>

View File

@@ -1,372 +0,0 @@
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
<title>MochiKit.Iter - itertools for JavaScript; iteration made HARD, and then easy</title>
<link rel="stylesheet" href="../../../include/css/documentation.css" type="text/css" />
<script type="text/javascript" src="../../../packed/lib/MochiKit/MochiKit.js"></script>
<script type="text/javascript" src="../../js/toc.js"></script>
</head>
<body>
<div class="document">
<div class="section">
<h1><a id="name" name="name">Name</a></h1>
<p>MochiKit.Iter - itertools for JavaScript; iteration made HARD, and then easy</p>
</div>
<div class="section">
<h1><a id="synopsis" name="synopsis">Synopsis</a></h1>
<pre class="literal-block">
theSum = sum(takewhile(
partial(operator.gt, 10),
imap(
partial(operator.mul, 2),
count()
)
)
));
assert( theSum == (0 + 0 + 2 + 4 + 6 + 8) );
</pre>
</div>
<div class="section">
<h1><a id="description" name="description">Description</a></h1>
<p>All of the functional programming missing from <a class="mochiref reference" href="Base.html">MochiKit.Base</a> lives
here. The functionality in this module is largely inspired by Python's iteration
protocol <a class="footnote-reference" href="#id4" id="id1" name="id1">[1]</a>, and the itertools module <a class="footnote-reference" href="#id5" id="id2" name="id2">[2]</a>.</p>
<p>MochiKit.Iter defines a standard way to iterate over anything, that you can
extend with <a class="mochiref reference" href="#fn-registeriterator">registerIterator</a>, or by implementing the <tt class="docutils literal"><span class="pre">.iter()</span></tt>
protocol. Iterators are lazy, so it can potentially be cheaper to build a
filter chain of iterators than to build lots of intermediate arrays.
Especially when the data set is very large, but the result is not.</p>
</div>
<div class="section">
<h1><a id="dependencies" name="dependencies">Dependencies</a></h1>
<ul class="simple">
<li><a class="mochiref reference" href="Base.html">MochiKit.Base</a></li>
</ul>
</div>
<div class="section">
<h1><a id="overview" name="overview">Overview</a></h1>
<div class="section">
<h2><a id="iteration-for-javascript" name="iteration-for-javascript">Iteration for JavaScript</a></h2>
<p>The best overview right now is in my Iteration for JavaScript <a class="footnote-reference" href="#id6" id="id3" name="id3">[3]</a> blog entry.
This information will migrate here eventually.</p>
</div>
</div>
<div class="section">
<h1><a id="api-reference" name="api-reference">API Reference</a></h1>
<div class="section">
<h2><a id="errors" name="errors">Errors</a></h2>
<p>
<a name="fn-stopiteration"></a>
<a class="mochidef reference" href="#fn-stopiteration">StopIteration</a>:</p>
<blockquote>
The singleton <a class="mochiref reference" href="Base.html#fn-namederror">MochiKit.Base.NamedError</a> that signifies the end
of an iterator</blockquote>
</div>
<div class="section">
<h2><a id="functions" name="functions">Functions</a></h2>
<p>
<a name="fn-applymap"></a>
<a class="mochidef reference" href="#fn-applymap">applymap(fun, seq[, self])</a>:</p>
<blockquote>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">applymap(fun,</span> <span class="pre">seq)</span></tt> --&gt;</dt>
<dd>fun.apply(self, seq0), fun.apply(self, seq1), ...</dd>
</dl>
</blockquote>
<p>
<a name="fn-chain"></a>
<a class="mochidef reference" href="#fn-chain">chain(p, q[, ...])</a>:</p>
<blockquote>
<tt class="docutils literal"><span class="pre">chain(p,</span> <span class="pre">q,</span> <span class="pre">...)</span></tt> --&gt; p0, p1, ... plast, q0, q1, ...</blockquote>
<p>
<a name="fn-count"></a>
<a class="mochidef reference" href="#fn-count">count(n=0)</a>:</p>
<blockquote>
<tt class="docutils literal"><span class="pre">count(n=0)</span></tt> --&gt; n, n + 1, n + 2, ...</blockquote>
<p>
<a name="fn-cycle"></a>
<a class="mochidef reference" href="#fn-cycle">cycle(p)</a>:</p>
<blockquote>
<tt class="docutils literal"><span class="pre">cycle(p)</span></tt> --&gt; p0, p1, ... plast, p0, p1, ...</blockquote>
<p>
<a name="fn-dropwhile"></a>
<a class="mochidef reference" href="#fn-dropwhile">dropwhile(pred, seq)</a>:</p>
<blockquote>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">dropwhile(pred,</span> <span class="pre">seq)</span></tt> --&gt; seq[n], seq[n + 1], starting when</dt>
<dd>pred(seq[n]) fails</dd>
</dl>
</blockquote>
<p>
<a name="fn-every"></a>
<a class="mochidef reference" href="#fn-every">every(iterable, func)</a>:</p>
<blockquote>
Return <tt class="docutils literal"><span class="pre">true</span></tt> if <tt class="docutils literal"><span class="pre">func(item)</span></tt> is <tt class="docutils literal"><span class="pre">true</span></tt> for every item in
<tt class="docutils literal"><span class="pre">iterable</span></tt>.</blockquote>
<p>
<a name="fn-exhaust"></a>
<a class="mochidef reference" href="#fn-exhaust">exhaust(iterable)</a>:</p>
<blockquote>
Exhausts an iterable without saving the results anywhere,
like <a class="mochiref reference" href="#fn-list">list(iterable)</a> when you don't care what the output is.</blockquote>
<p>
<a name="fn-foreach"></a>
<a class="mochidef reference" href="#fn-foreach">forEach(iterable, func[, self])</a>:</p>
<blockquote>
Call <tt class="docutils literal"><span class="pre">func</span></tt> for each item in <tt class="docutils literal"><span class="pre">iterable</span></tt>, and don't save the results.</blockquote>
<p>
<a name="fn-groupby"></a>
<a class="mochidef reference" href="#fn-groupby">groupby(iterable[, keyfunc])</a>:</p>
<blockquote>
<p>Make an iterator that returns consecutive keys and groups from the
iterable. The key is a function computing a key value for each element.
If not specified or is None, key defaults to an identity function and
returns the element unchanged. Generally, the iterable needs to already be
sorted on the same key function.</p>
<p>The returned group is itself an iterator that shares the underlying
iterable with <a class="mochiref reference" href="#fn-groupby">groupby()</a>. Because the source is shared, when the
groupby object is advanced, the previous group is no longer visible.
So, if that data is needed later, it should be stored as an array:</p>
<pre class="literal-block">
var groups = [];
var uniquekeys = [];
forEach(groupby(data, keyfunc), function (key_group) {
groups.push(list(key_group[1]));
uniquekeys.push(key_group[0]);
});
</pre>
<p>As a convenience, <a class="mochiref reference" href="#fn-groupby_as_array">groupby_as_array()</a> is provided to suit the above
use case.</p>
</blockquote>
<p>
<a name="fn-groupby_as_array"></a>
<a class="mochidef reference" href="#fn-groupby_as_array">groupby_as_array(iterable[, keyfunc])</a>:</p>
<blockquote>
Perform the same task as <a class="mochiref reference" href="#fn-groupby">groupby()</a>, except return an array of
arrays instead of an iterator of iterators.</blockquote>
<p>
<a name="fn-iextend"></a>
<a class="mochidef reference" href="#fn-iextend">iextend(lst, iterable)</a>:</p>
<blockquote>
Just like <a class="mochiref reference" href="#fn-list">list(iterable)</a>, except it pushes results on <tt class="docutils literal"><span class="pre">lst</span></tt>
rather than creating a new one.</blockquote>
<p>
<a name="fn-ifilter"></a>
<a class="mochidef reference" href="#fn-ifilter">ifilter(pred, seq)</a>:</p>
<blockquote>
<tt class="docutils literal"><span class="pre">ifilter(pred,</span> <span class="pre">seq)</span></tt> --&gt; elements of seq where <tt class="docutils literal"><span class="pre">pred(elem)</span></tt> is <tt class="docutils literal"><span class="pre">true</span></tt></blockquote>
<p>
<a name="fn-ifilterfalse"></a>
<a class="mochidef reference" href="#fn-ifilterfalse">ifilterfalse(pred, seq)</a>:</p>
<blockquote>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">ifilterfalse(pred,</span> <span class="pre">seq)</span></tt> --&gt; elements of seq where <tt class="docutils literal"><span class="pre">pred(elem)</span></tt> is</dt>
<dd><tt class="docutils literal"><span class="pre">false</span></tt></dd>
</dl>
</blockquote>
<p>
<a name="fn-imap"></a>
<a class="mochidef reference" href="#fn-imap">imap(fun, p, q[, ...])</a>:</p>
<blockquote>
<tt class="docutils literal"><span class="pre">imap(fun,</span> <span class="pre">p,</span> <span class="pre">q,</span> <span class="pre">...)</span></tt> --&gt; fun(p0, q0, ...), fun(p1, q1, ...), ...</blockquote>
<p>
<a name="fn-islice"></a>
<a class="mochidef reference" href="#fn-islice">islice(seq, [start,] stop[, step])</a>:</p>
<blockquote>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">islice(seq,</span> <span class="pre">[start,]</span> <span class="pre">stop[,</span> <span class="pre">step])</span></tt> --&gt; elements from</dt>
<dd>seq[start:stop:step] (in Python slice syntax)</dd>
</dl>
</blockquote>
<p>
<a name="fn-iter"></a>
<a class="mochidef reference" href="#fn-iter">iter(iterable[, sentinel])</a>:</p>
<blockquote>
<p>Convert the given argument to an iterator (object implementing
<tt class="docutils literal"><span class="pre">.next()</span></tt>).</p>
<ol class="arabic simple">
<li>If <tt class="docutils literal"><span class="pre">iterable</span></tt> is an iterator (implements <tt class="docutils literal"><span class="pre">.next()</span></tt>), then it will
be returned as-is.</li>
<li>If <tt class="docutils literal"><span class="pre">iterable</span></tt> is an iterator factory (implements <tt class="docutils literal"><span class="pre">.iter()</span></tt>), then
the result of <tt class="docutils literal"><span class="pre">iterable.iter()</span></tt> will be returned.</li>
<li>Otherwise, the iterator factory <a class="mochiref reference" href="Base.html#fn-adapterregistry">MochiKit.Base.AdapterRegistry</a>
is used to find a match.</li>
<li>If no factory is found, it will throw <tt class="docutils literal"><span class="pre">TypeError</span></tt></li>
</ol>
<p>Built-in iterator factories are present for Array-like objects, and
objects that implement the <tt class="docutils literal"><span class="pre">iterateNext</span></tt> protocol (e.g. the result of
Mozilla's <tt class="docutils literal"><span class="pre">document.evaluate</span></tt>).</p>
<p>When used directly, using an iterator should look like this:</p>
<pre class="literal-block">
var it = iter(iterable);
try {
while (var o = it.next()) {
// use o
}
} catch (e) {
if (e != StopIteration) {
throw e;
}
// pass
}
</pre>
<p>This is ugly, so you should use the higher order functions to work
with iterators whenever possible.</p>
</blockquote>
<p>
<a name="fn-izip"></a>
<a class="mochidef reference" href="#fn-izip">izip(p, q[, ...])</a>:</p>
<blockquote>
<tt class="docutils literal"><span class="pre">izip(p,</span> <span class="pre">q,</span> <span class="pre">...)</span></tt> --&gt; [p0, q0, ...], [p1, q1, ...], ...</blockquote>
<p>
<a name="fn-list"></a>
<a class="mochidef reference" href="#fn-list">list(iterable)</a>:</p>
<blockquote>
Convert <tt class="docutils literal"><span class="pre">iterable</span></tt> to a new <tt class="docutils literal"><span class="pre">Array</span></tt></blockquote>
<p>
<a name="fn-next"></a>
<a class="mochidef reference" href="#fn-next">next(iterator)</a>:</p>
<blockquote>
Return <tt class="docutils literal"><span class="pre">iterator.next()</span></tt></blockquote>
<p>
<a name="fn-range"></a>
<a class="mochidef reference" href="#fn-range">range([start,] stop[, step])</a>:</p>
<blockquote>
<p>Return an iterator containing an arithmetic progression of integers.</p>
<p><tt class="docutils literal"><span class="pre">range(i,</span> <span class="pre">j)</span></tt> returns <a class="mochiref reference" href="#fn-iter">iter([i, i + 1, i + 2, ..., j - 1])</a></p>
<p><tt class="docutils literal"><span class="pre">start</span></tt> (!) defaults to <tt class="docutils literal"><span class="pre">0</span></tt>. When <tt class="docutils literal"><span class="pre">step</span></tt> is given, it specifies the
increment (or decrement). The end point is omitted!</p>
<p>For example, <tt class="docutils literal"><span class="pre">range(4)</span></tt> returns <a class="mochiref reference" href="#fn-iter">iter([0, 1, 2, 3])</a>.
This iterates over exactly the valid indexes for an array of 4 elements.</p>
</blockquote>
<p>
<a name="fn-reduce"></a>
<a class="mochidef reference" href="#fn-reduce">reduce(fn, iterable[, initial])</a>:</p>
<blockquote>
<p>Apply <tt class="docutils literal"><span class="pre">fn(a,</span> <span class="pre">b)</span></tt> cumulatively to the items of an
iterable from left to right, so as to reduce the iterable
to a single value.</p>
<p>For example:</p>
<pre class="literal-block">
reduce(function (a, b) { return x + y; }, [1, 2, 3, 4, 5])
</pre>
<p>calculates:</p>
<pre class="literal-block">
((((1 + 2) + 3) + 4) + 5).
</pre>
<p>If initial is given, it is placed before the items of the sequence
in the calculation, and serves as a default when the sequence is
empty.</p>
<p>Note that the above example could be written more clearly as:</p>
<pre class="literal-block">
reduce(operator.add, [1, 2, 3, 4, 5])
</pre>
<p>Or even simpler:</p>
<pre class="literal-block">
sum([1, 2, 3, 4, 5])
</pre>
</blockquote>
<p>
<a name="fn-registeriteratorfactory"></a>
<a class="mochidef reference" href="#fn-registeriteratorfactory">registerIteratorFactory(name, check, iterfactory[, override])</a>:</p>
<blockquote>
<p>Register an iterator factory for use with the iter function.</p>
<p><tt class="docutils literal"><span class="pre">check</span></tt> is a <tt class="docutils literal"><span class="pre">function(a)</span></tt> that returns <tt class="docutils literal"><span class="pre">true</span></tt> if <tt class="docutils literal"><span class="pre">a</span></tt> can be
converted into an iterator with <tt class="docutils literal"><span class="pre">iterfactory</span></tt>.</p>
<p><tt class="docutils literal"><span class="pre">iterfactory</span></tt> is a <tt class="docutils literal"><span class="pre">function(a)</span></tt> that returns an object with a
<tt class="docutils literal"><span class="pre">.next()</span></tt> method that returns the next value in the sequence.</p>
<p><tt class="docutils literal"><span class="pre">iterfactory</span></tt> is guaranteed to only be called if <tt class="docutils literal"><span class="pre">check(a)</span></tt>
returns a true value.</p>
<p>If <tt class="docutils literal"><span class="pre">override</span></tt> is <tt class="docutils literal"><span class="pre">true</span></tt>, then it will be made the
highest precedence iterator factory. Otherwise, the lowest.</p>
</blockquote>
<p>
<a name="fn-repeat"></a>
<a class="mochidef reference" href="#fn-repeat">repeat(elem[, n])</a>:</p>
<blockquote>
<tt class="docutils literal"><span class="pre">repeat(elem,</span> <span class="pre">[,n])</span></tt> --&gt; elem, elem, elem, ... endlessly or up to n times</blockquote>
<p>
<a name="fn-reversed"></a>
<a class="mochidef reference" href="#fn-reversed">reversed(iterable)</a>:</p>
<blockquote>
Return a reversed array from iterable.</blockquote>
<p>
<a name="fn-some"></a>
<a class="mochidef reference" href="#fn-some">some(iterable, func)</a>:</p>
<blockquote>
Return <tt class="docutils literal"><span class="pre">true</span></tt> if <tt class="docutils literal"><span class="pre">func(item)</span></tt> is <tt class="docutils literal"><span class="pre">true</span></tt> for at least one item in
<tt class="docutils literal"><span class="pre">iterable</span></tt>.</blockquote>
<p>
<a name="fn-sorted"></a>
<a class="mochidef reference" href="#fn-sorted">sorted(iterable[, cmp])</a>:</p>
<blockquote>
Return a sorted array from iterable.</blockquote>
<p>
<a name="fn-sum"></a>
<a class="mochidef reference" href="#fn-sum">sum(iterable, start=0)</a>:</p>
<blockquote>
<p>Returns the sum of a sequence of numbers plus the value
of parameter <tt class="docutils literal"><span class="pre">start</span></tt> (with a default of 0). When the sequence is
empty, returns start.</p>
<p>Equivalent to:</p>
<pre class="literal-block">
reduce(operator.add, iterable, start);
</pre>
</blockquote>
<p>
<a name="fn-takewhile"></a>
<a class="mochidef reference" href="#fn-takewhile">takewhile(pred, seq)</a>:</p>
<blockquote>
<tt class="docutils literal"><span class="pre">takewhile(pred,</span> <span class="pre">seq)</span></tt> --&gt; seq[0], seq[1], ... until pred(seq[n]) fails</blockquote>
<p>
<a name="fn-tee"></a>
<a class="mochidef reference" href="#fn-tee">tee(iterable, n=2)</a>:</p>
<blockquote>
<tt class="docutils literal"><span class="pre">tee(it,</span> <span class="pre">n=2)</span></tt> --&gt; [it1, it2, it3, ... itn] splits one iterator into n</blockquote>
</div>
</div>
<div class="section">
<h1><a id="see-also" name="see-also">See Also</a></h1>
<table class="docutils footnote" frame="void" id="id4" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id1" name="id4">[1]</a></td><td>The iteration protocol is described in
PEP 234 - Iterators: <a class="reference" href="http://www.python.org/peps/pep-0234.html">http://www.python.org/peps/pep-0234.html</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id5" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id2" name="id5">[2]</a></td><td>Python's itertools
module: <a class="reference" href="http://docs.python.org/lib/module-itertools.html">http://docs.python.org/lib/module-itertools.html</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id6" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id3" name="id6">[3]</a></td><td>Iteration in JavaScript: <a class="reference" href="http://bob.pythonmac.org/archives/2005/07/06/iteration-in-javascript/">http://bob.pythonmac.org/archives/2005/07/06/iteration-in-javascript/</a></td></tr>
</tbody>
</table>
</div>
<div class="section">
<h1><a id="authors" name="authors">Authors</a></h1>
<ul class="simple">
<li>Bob Ippolito &lt;<a class="reference" href="mailto:bob&#64;redivi.com">bob&#64;redivi.com</a>&gt;</li>
</ul>
</div>
<div class="section">
<h1><a id="copyright" name="copyright">Copyright</a></h1>
<p>Copyright 2005 Bob Ippolito &lt;<a class="reference" href="mailto:bob&#64;redivi.com">bob&#64;redivi.com</a>&gt;. This program is dual-licensed
free software; you can redistribute it and/or modify it under the terms of the
<a class="reference" href="http://www.opensource.org/licenses/mit-license.php">MIT License</a> or the <a class="reference" href="http://www.opensource.org/licenses/afl-2.1.php">Academic Free License v2.1</a>.</p>
</div>
</div>
</body>
</html>

View File

@@ -1,310 +0,0 @@
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
<title>MochiKit.Logging - we're all tired of alert()</title>
<link rel="stylesheet" href="../../../include/css/documentation.css" type="text/css" />
<script type="text/javascript" src="../../../packed/lib/MochiKit/MochiKit.js"></script>
<script type="text/javascript" src="../../js/toc.js"></script>
</head>
<body>
<div class="document">
<div class="section">
<h1><a id="name" name="name">Name</a></h1>
<p>MochiKit.Logging - we're all tired of alert()</p>
</div>
<div class="section">
<h1><a id="synopsis" name="synopsis">Synopsis</a></h1>
<pre class="literal-block">
log(&quot;INFO messages are so boring&quot;);
logDebug(&quot;DEBUG messages are even worse&quot;);
log(&quot;good thing I can pass&quot;, objects, &quot;conveniently&quot;);
</pre>
</div>
<div class="section">
<h1><a id="description" name="description">Description</a></h1>
<p>MochiKit.Logging steals some ideas from Python's logging module <a class="footnote-reference" href="#id6" id="id1" name="id1">[1]</a>, but
completely forgot about the Java <a class="footnote-reference" href="#id7" id="id2" name="id2">[2]</a> inspiration. This is a KISS module for
logging that provides enough flexibility to do just about anything via
listeners, but without all the cruft.</p>
</div>
<div class="section">
<h1><a id="dependencies" name="dependencies">Dependencies</a></h1>
<ul class="simple">
<li><a class="mochiref reference" href="Base.html">MochiKit.Base</a></li>
</ul>
</div>
<div class="section">
<h1><a id="overview" name="overview">Overview</a></h1>
<div class="section">
<h2><a id="native-console-logging" name="native-console-logging">Native Console Logging</a></h2>
<p>As of MochiKit 1.3, the default logger will log all messages to your browser's
native console. This is currently supported in Safari, Opera 9, and Firefox
when the <a class="reference" href="http://www.joehewitt.com/software/firebug/">FireBug</a> extension is installed.</p>
<p>To disable this behavior:</p>
<pre class="literal-block">
MochiKit.Logging.logger.useNativeLogging = false;
</pre>
</div>
<div class="section">
<h2><a id="bookmarklet-based-debugging" name="bookmarklet-based-debugging">Bookmarklet Based Debugging</a></h2>
<p>JavaScript is at a serious disadvantage without a standard console for
&quot;print&quot; statements. Everything else has one. The closest thing that
you get in a browser environment is the <tt class="docutils literal"><span class="pre">alert</span></tt> function, which is
absolutely evil.</p>
<p>This leaves you with one reasonable solution: do your logging in the page
somehow. The problem here is that you don't want to clutter the page with
debugging tools. The solution to that problem is what we call BBD, or
Bookmarklet Based Debugging <a class="footnote-reference" href="#id8" id="id4" name="id4">[3]</a>.</p>
<p>Simply create a bookmarklet for <a class="reference" href="javascript:MochiKit.Logging.logger.debuggingBookmarklet()">javascript:MochiKit.Logging.logger.debuggingBookmarklet()</a>,
and whack it whenever you want to see what's in the logger. Of course, this
means you must drink the MochiKit.Logging kool-aid. It's tangy and sweet,
don't worry.</p>
<p>Currently this is an ugly <tt class="docutils literal"><span class="pre">alert</span></tt>, but we'll have something spiffy
Real Soon Now, and when we do, you only have to upgrade MochiKit.Logging,
not your bookmarklet!</p>
</div>
</div>
<div class="section">
<h1><a id="api-reference" name="api-reference">API Reference</a></h1>
<div class="section">
<h2><a id="constructors" name="constructors">Constructors</a></h2>
<p>
<a name="fn-logmessage"></a>
<a class="mochidef reference" href="#fn-logmessage">LogMessage(num, level, info)</a>:</p>
<blockquote>
<p>Properties:</p>
<blockquote>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">num</span></tt>:</dt>
<dd>Identifier for the log message</dd>
<dt><tt class="docutils literal"><span class="pre">level</span></tt>:</dt>
<dd>Level of the log message (<tt class="docutils literal"><span class="pre">&quot;INFO&quot;</span></tt>, <tt class="docutils literal"><span class="pre">&quot;WARN&quot;</span></tt>, <tt class="docutils literal"><span class="pre">&quot;DEBUG&quot;</span></tt>,
etc.)</dd>
<dt><tt class="docutils literal"><span class="pre">info</span></tt>:</dt>
<dd>All other arguments passed to log function as an <tt class="docutils literal"><span class="pre">Array</span></tt></dd>
<dt><tt class="docutils literal"><span class="pre">timestamp</span></tt>:</dt>
<dd><tt class="docutils literal"><span class="pre">Date</span></tt> object timestamping the log message</dd>
</dl>
</blockquote>
</blockquote>
<p>
<a name="fn-logger"></a>
<a class="mochidef reference" href="#fn-logger">Logger([maxSize])</a>:</p>
<blockquote>
<p>A basic logger object that has a buffer of recent messages
plus a listener dispatch mechanism for &quot;real-time&quot; logging
of important messages.</p>
<p><tt class="docutils literal"><span class="pre">maxSize</span></tt> is the maximum number of entries in the log.
If <tt class="docutils literal"><span class="pre">maxSize</span> <span class="pre">&gt;=</span> <span class="pre">0</span></tt>, then the log will not buffer more than that
many messages. So if you don't like logging at all, be sure to
pass <tt class="docutils literal"><span class="pre">0</span></tt>.</p>
<p>There is a default logger available named &quot;logger&quot;, and several
of its methods are also global functions:</p>
<blockquote>
<tt class="docutils literal"><span class="pre">logger.log</span></tt> -&gt; <tt class="docutils literal"><span class="pre">log</span></tt>
<tt class="docutils literal"><span class="pre">logger.debug</span></tt> -&gt; <tt class="docutils literal"><span class="pre">logDebug</span></tt>
<tt class="docutils literal"><span class="pre">logger.warning</span></tt> -&gt; <tt class="docutils literal"><span class="pre">logWarning</span></tt>
<tt class="docutils literal"><span class="pre">logger.error</span></tt> -&gt; <tt class="docutils literal"><span class="pre">logError</span></tt>
<tt class="docutils literal"><span class="pre">logger.fatal</span></tt> -&gt; <tt class="docutils literal"><span class="pre">logFatal</span></tt></blockquote>
</blockquote>
<p>
<a name="fn-logger.prototype.addlistener"></a>
<a class="mochidef reference" href="#fn-logger.prototype.addlistener">Logger.prototype.addListener(ident, filter, listener)</a>:</p>
<blockquote>
<p>Add a listener for log messages.</p>
<p><tt class="docutils literal"><span class="pre">ident</span></tt> is a unique identifier that may be used to remove the listener
later on.</p>
<p><tt class="docutils literal"><span class="pre">filter</span></tt> can be one of the following:</p>
<blockquote>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">null</span></tt>:</dt>
<dd><tt class="docutils literal"><span class="pre">listener(msg)</span></tt> will be called for every log message
received.</dd>
<dt><tt class="docutils literal"><span class="pre">string</span></tt>:</dt>
<dd><a class="mochiref reference" href="#fn-loglevelatleast">logLevelAtLeast(filter)</a> will be used as the function
(see below).</dd>
<dt><tt class="docutils literal"><span class="pre">function</span></tt>:</dt>
<dd><tt class="docutils literal"><span class="pre">filter(msg)</span></tt> will be called for every msg, if it returns
true then <tt class="docutils literal"><span class="pre">listener(msg)</span></tt> will be called.</dd>
</dl>
</blockquote>
<p><tt class="docutils literal"><span class="pre">listener</span></tt> is a function that takes one argument, a log message. A log
message is an object (<a class="mochiref reference" href="#fn-logmessage">LogMessage</a> instance) that has at least these
properties:</p>
<blockquote>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">num</span></tt>:</dt>
<dd>A counter that uniquely identifies a log message (per-logger)</dd>
<dt><tt class="docutils literal"><span class="pre">level</span></tt>:</dt>
<dd>A string or number representing the log level. If string, you
may want to use <tt class="docutils literal"><span class="pre">LogLevel[level]</span></tt> for comparison.</dd>
<dt><tt class="docutils literal"><span class="pre">info</span></tt>:</dt>
<dd>An Array of objects passed as additional arguments to the <tt class="docutils literal"><span class="pre">log</span></tt>
function.</dd>
</dl>
</blockquote>
</blockquote>
<p>
<a name="fn-logger.prototype.baselog"></a>
<a class="mochidef reference" href="#fn-logger.prototype.baselog">Logger.prototype.baseLog(level, message[, ...])</a>:</p>
<blockquote>
<p>The base functionality behind all of the log functions.
The first argument is the log level as a string or number,
and all other arguments are used as the info list.</p>
<p>This function is available partially applied as:</p>
<blockquote>
<table border="1" class="docutils">
<colgroup>
<col width="61%" />
<col width="39%" />
</colgroup>
<tbody valign="top">
<tr><td>Logger.debug</td>
<td>'DEBUG'</td>
</tr>
<tr><td>Logger.log</td>
<td>'INFO'</td>
</tr>
<tr><td>Logger.error</td>
<td>'ERROR'</td>
</tr>
<tr><td>Logger.fatal</td>
<td>'FATAL'</td>
</tr>
<tr><td>Logger.warning</td>
<td>'WARNING'</td>
</tr>
</tbody>
</table>
</blockquote>
<p>For the default logger, these are also available as global functions,
see the <a class="mochiref reference" href="#fn-logger">Logger</a> constructor documentation for more info.</p>
</blockquote>
<p>
<a name="fn-logger.prototype.clear"></a>
<a class="mochidef reference" href="#fn-logger.prototype.clear">Logger.prototype.clear()</a>:</p>
<blockquote>
Clear all messages from the message buffer.</blockquote>
<p>
<a name="fn-logger.prototype.debuggingbookmarklet"></a>
<a class="mochidef reference" href="#fn-logger.prototype.debuggingbookmarklet">Logger.prototype.debuggingBookmarklet()</a>:</p>
<blockquote>
<p>Display the contents of the logger in a useful way for browsers.</p>
<p>Currently, if <a class="mochiref reference" href="LoggingPane.html">MochiKit.LoggingPane</a> is loaded, then a pop-up
<a class="mochiref reference" href="LoggingPane.html#fn-loggingpane">MochiKit.LoggingPane.LoggingPane</a> will be used. Otherwise,
it will be an alert with <a class="mochiref reference" href="#fn-logger.prototype.getmessagetext">Logger.prototype.getMessageText()</a>.</p>
</blockquote>
<p>
<a name="fn-logger.prototype.dispatchlisteners"></a>
<a class="mochidef reference" href="#fn-logger.prototype.dispatchlisteners">Logger.prototype.dispatchListeners(msg)</a>:</p>
<blockquote>
Dispatch a log message to all listeners.</blockquote>
<p>
<a name="fn-logger.prototype.getmessages"></a>
<a class="mochidef reference" href="#fn-logger.prototype.getmessages">Logger.prototype.getMessages(howMany)</a>:</p>
<blockquote>
Return a list of up to <tt class="docutils literal"><span class="pre">howMany</span></tt> messages from the message buffer.</blockquote>
<p>
<a name="fn-logger.prototype.getmessagetext"></a>
<a class="mochidef reference" href="#fn-logger.prototype.getmessagetext">Logger.prototype.getMessageText(howMany)</a>:</p>
<blockquote>
<p>Get a string representing up to the last <tt class="docutils literal"><span class="pre">howMany</span></tt> messages in the
message buffer. The default is <tt class="docutils literal"><span class="pre">30</span></tt>.</p>
<p>The message looks like this:</p>
<pre class="literal-block">
LAST {messages.length} MESSAGES:
[{msg.num}] {msg.level}: {m.info.join(' ')}
[{msg.num}] {msg.level}: {m.info.join(' ')}
...
</pre>
<p>If you want some other format, use
<a class="mochiref reference" href="#fn-logger.prototype.getmessages">Logger.prototype.getMessages</a> and do it yourself.</p>
</blockquote>
<p>
<a name="fn-logger.prototype.removelistener"></a>
<a class="mochidef reference" href="#fn-logger.prototype.removelistener">Logger.prototype.removeListener(ident)</a>:</p>
<blockquote>
Remove a listener using the ident given to <a class="mochiref reference" href="#fn-logger.prototype.addlistener">Logger.prototype.addListener</a></blockquote>
</div>
<div class="section">
<h2><a id="functions" name="functions">Functions</a></h2>
<p>
<a name="fn-alertlistener"></a>
<a class="mochidef reference" href="#fn-alertlistener">alertListener(msg)</a>:</p>
<blockquote>
Ultra-obnoxious <tt class="docutils literal"><span class="pre">alert(...)</span></tt> listener</blockquote>
<p>
<a name="fn-logdebug"></a>
<a class="mochidef reference" href="#fn-logdebug">logDebug(message[, info[, ...]])</a>:</p>
<blockquote>
Log an INFO message to the default logger</blockquote>
<p>
<a name="fn-logdebug"></a>
<a class="mochidef reference" href="#fn-logdebug">logDebug(message[, info[, ...]])</a>:</p>
<blockquote>
Log a DEBUG message to the default logger</blockquote>
<p>
<a name="fn-logerror"></a>
<a class="mochidef reference" href="#fn-logerror">logError(message[, info[, ...]])</a>:</p>
<blockquote>
Log an ERROR message to the default logger</blockquote>
<p>
<a name="fn-logfatal"></a>
<a class="mochidef reference" href="#fn-logfatal">logFatal(message[, info[, ...]])</a>:</p>
<blockquote>
Log a FATAL message to the default logger</blockquote>
<p>
<a name="fn-loglevelatleast"></a>
<a class="mochidef reference" href="#fn-loglevelatleast">logLevelAtLeast(minLevel)</a>:</p>
<blockquote>
Return a function that will match log messages whose level
is at least minLevel</blockquote>
<p>
<a name="fn-logwarning"></a>
<a class="mochidef reference" href="#fn-logwarning">logWarning(message[, info[, ...]])</a>:</p>
<blockquote>
Log a WARNING message to the default logger</blockquote>
</div>
</div>
<div class="section">
<h1><a id="see-also" name="see-also">See Also</a></h1>
<table class="docutils footnote" frame="void" id="id6" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id1" name="id6">[1]</a></td><td>Python's logging module: <a class="reference" href="http://docs.python.org/lib/module-logging.html">http://docs.python.org/lib/module-logging.html</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id7" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id2" name="id7">[2]</a></td><td>PEP 282, where they admit all of the Java influence: <a class="reference" href="http://www.python.org/peps/pep-0282.html">http://www.python.org/peps/pep-0282.html</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id8" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id4" name="id8">[3]</a></td><td>Original Bookmarklet Based Debugging blather: <a class="reference" href="http://bob.pythonmac.org/archives/2005/07/03/bookmarklet-based-debugging/">http://bob.pythonmac.org/archives/2005/07/03/bookmarklet-based-debugging/</a></td></tr>
</tbody>
</table>
</div>
<div class="section">
<h1><a id="authors" name="authors">Authors</a></h1>
<ul class="simple">
<li>Bob Ippolito &lt;<a class="reference" href="mailto:bob&#64;redivi.com">bob&#64;redivi.com</a>&gt;</li>
</ul>
</div>
<div class="section">
<h1><a id="copyright" name="copyright">Copyright</a></h1>
<p>Copyright 2005 Bob Ippolito &lt;<a class="reference" href="mailto:bob&#64;redivi.com">bob&#64;redivi.com</a>&gt;. This program is dual-licensed
free software; you can redistribute it and/or modify it under the terms of the
<a class="reference" href="http://www.opensource.org/licenses/mit-license.php">MIT License</a> or the <a class="reference" href="http://www.opensource.org/licenses/afl-2.1.php">Academic Free License v2.1</a>.</p>
</div>
</div>
</body>
</html>

View File

@@ -1,121 +0,0 @@
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
<title>MochiKit.LoggingPane - Interactive MochiKit.Logging pane</title>
<link rel="stylesheet" href="../../../include/css/documentation.css" type="text/css" />
<script type="text/javascript" src="../../../packed/lib/MochiKit/MochiKit.js"></script>
<script type="text/javascript" src="../../js/toc.js"></script>
</head>
<body>
<div class="document">
<div class="section">
<h1><a id="name" name="name">Name</a></h1>
<p>MochiKit.LoggingPane - Interactive MochiKit.Logging pane</p>
</div>
<div class="section">
<h1><a id="synopsis" name="synopsis">Synopsis</a></h1>
<pre class="literal-block">
// open a pop-up window
createLoggingPane()
// use a div at the bottom of the document
createLoggingPane(true);
</pre>
</div>
<div class="section">
<h1><a id="description" name="description">Description</a></h1>
<p>MochiKit.Logging does not have any browser dependencies and is completely
unobtrusive. MochiKit.LoggingPane is a browser-based colored viewing pane
for your <a class="mochiref reference" href="Logging.html">MochiKit.Logging</a> output that can be used as a pop-up or
inline.</p>
<p>It also allows for regex and level filtering! MochiKit.LoggingPane is used
as the default <a class="mochiref reference" href="Logging.html#fn-debuggingbookmarklet">MochiKit.Logging.debuggingBookmarklet()</a> if it is
loaded.</p>
</div>
<div class="section">
<h1><a id="dependencies" name="dependencies">Dependencies</a></h1>
<ul class="simple">
<li><a class="mochiref reference" href="Base.html">MochiKit.Base</a></li>
<li><a class="mochiref reference" href="Logging.html">MochiKit.Logging</a></li>
</ul>
</div>
<div class="section">
<h1><a id="api-reference" name="api-reference">API Reference</a></h1>
<div class="section">
<h2><a id="constructors" name="constructors">Constructors</a></h2>
<p>
<a name="fn-loggingpane"></a>
<a class="mochidef reference" href="#fn-loggingpane">LoggingPane(inline=false, logger=MochiKit.Logging.logger)</a>:</p>
<blockquote>
<p>A listener for a <a class="mochiref reference" href="Logging.html">MochiKit.Logging</a> logger with an interactive
DOM representation.</p>
<p>If <tt class="docutils literal"><span class="pre">inline</span></tt> is <tt class="docutils literal"><span class="pre">true</span></tt>, then the <tt class="docutils literal"><span class="pre">LoggingPane</span></tt> will be a <tt class="docutils literal"><span class="pre">DIV</span></tt>
at the bottom of the document. Otherwise, it will be in a pop-up
window with a name based on the calling page's URL. If there is an
element in the document with an id of <tt class="docutils literal"><span class="pre">_MochiKit_LoggingPane</span></tt>,
it will be used instead of appending a new <tt class="docutils literal"><span class="pre">DIV</span></tt> to the body.</p>
<p><tt class="docutils literal"><span class="pre">logger</span></tt> is the reference to the <a class="mochiref reference" href="Logging.html#fn-logger">MochiKit.Logging.Logger</a> to
listen to. If not specified, the global default logger is used.</p>
<p>Properties:</p>
<blockquote>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">win</span></tt>:</dt>
<dd>Reference to the pop-up window (<tt class="docutils literal"><span class="pre">undefined</span></tt> if <tt class="docutils literal"><span class="pre">inline</span></tt>)</dd>
<dt><tt class="docutils literal"><span class="pre">inline</span></tt>:</dt>
<dd><tt class="docutils literal"><span class="pre">true</span></tt> if the <tt class="docutils literal"><span class="pre">LoggingPane</span></tt> is inline</dd>
<dt><tt class="docutils literal"><span class="pre">colorTable</span></tt>:</dt>
<dd><p class="first">An object with property-&gt;value mappings for each log level
and its color. May also be mutated on <tt class="docutils literal"><span class="pre">LoggingPane.prototype</span></tt>
to affect all instances. For example:</p>
<pre class="last literal-block">
MochiKit.LoggingPane.LoggingPane.prototype.colorTable = {
DEBUG: &quot;green&quot;,
INFO: &quot;black&quot;,
WARNING: &quot;blue&quot;,
ERROR: &quot;red&quot;,
FATAL: &quot;darkred&quot;
};
</pre>
</dd>
</dl>
</blockquote>
</blockquote>
<p>
<a name="fn-loggingpane.prototype.closepane"></a>
<a class="mochidef reference" href="#fn-loggingpane.prototype.closepane">LoggingPane.prototype.closePane()</a>:</p>
<blockquote>
Close the <a class="mochiref reference" href="#fn-loggingpane">LoggingPane</a> (close the child window, or
remove the <tt class="docutils literal"><span class="pre">_MochiKit_LoggingPane</span></tt> <tt class="docutils literal"><span class="pre">DIV</span></tt> from the document).</blockquote>
</div>
<div class="section">
<h2><a id="functions" name="functions">Functions</a></h2>
<p>
<a name="fn-createloggingpane"></a>
<a class="mochidef reference" href="#fn-createloggingpane">createLoggingPane(inline=false)</a>:</p>
<blockquote>
Create or return an existing <a class="mochiref reference" href="#fn-loggingpane">LoggingPane</a> for this document
with the given inline setting. This is preferred over using
<a class="mochiref reference" href="#fn-loggingpane">LoggingPane</a> directly, as only one <a class="mochiref reference" href="#fn-loggingpane">LoggingPane</a>
should be present in a given document.</blockquote>
</div>
</div>
<div class="section">
<h1><a id="authors" name="authors">Authors</a></h1>
<ul class="simple">
<li>Bob Ippolito &lt;<a class="reference" href="mailto:bob&#64;redivi.com">bob&#64;redivi.com</a>&gt;</li>
</ul>
</div>
<div class="section">
<h1><a id="copyright" name="copyright">Copyright</a></h1>
<p>Copyright 2005 Bob Ippolito &lt;<a class="reference" href="mailto:bob&#64;redivi.com">bob&#64;redivi.com</a>&gt;. This program is dual-licensed
free software; you can redistribute it and/or modify it under the terms of the
<a class="reference" href="http://www.opensource.org/licenses/mit-license.php">MIT License</a> or the <a class="reference" href="http://www.opensource.org/licenses/afl-2.1.php">Academic Free License v2.1</a>.</p>
</div>
</div>
</body>
</html>

View File

@@ -1,331 +0,0 @@
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
<title>MochiKit.Signal - Simple universal event handling</title>
<link rel="stylesheet" href="../../../include/css/documentation.css" type="text/css" />
<script type="text/javascript" src="../../../packed/lib/MochiKit/MochiKit.js"></script>
<script type="text/javascript" src="../../js/toc.js"></script>
</head>
<body>
<div class="document">
<div class="section">
<h1><a id="name" name="name">Name</a></h1>
<p>MochiKit.Signal - Simple universal event handling</p>
</div>
<div class="section">
<h1><a id="synopsis" name="synopsis">Synopsis</a></h1>
<p>Signal for DOM events:</p>
<pre class="literal-block">
// DOM events are also signals. Connect freely! The functions will be
// called with the custom event as a parameter.
// calls myClicked.apply(getElement('myID'), event)
connect('myID', 'onclick', myClicked);
// calls wasClicked.apply(myObject, event)
connect('myID', 'onclick', myObject, wasClicked);
// calls myObject.wasClicked(event)
connect('myID', 'onclick', myObject, 'wasClicked');
// the event is normalized, no more e = e || window.event!
myObject.wasClicked = function(e) {
var crossBrowserCoordinates = e.mouse().page;
// e.mouse().page is a MochiKit.DOM.Coordinates object
}
</pre>
<p>Signal for non-DOM events:</p>
<pre class="literal-block">
// otherObject.gotFlash() will be called when 'flash' signalled.
connect(myObject, 'flash', otherObject, 'gotFlash');
// gotBang.apply(otherObject) will be called when 'bang' signalled.
// You can access otherObject from within gotBang as 'this'.
connect(myObject, 'bang', otherObject, gotBang);
// myFunc.apply(myObject) will be called when 'flash' signalled.
// You can access myObject from within myFunc as 'this'.
var ident = connect(myObject, 'flash', myFunc);
// You may disconnect with the return value from connect
disconnect(ident);
// Signal can take parameters. These will be passed along to the connected
// functions.
signal(myObject, 'flash');
signal(myObject, 'bang', 'BANG!');
</pre>
</div>
<div class="section">
<h1><a id="description" name="description">Description</a></h1>
<p>Event handling was never so easy!</p>
<p>This module takes care of all the hard work—figuring out which event
model to use, trying to retrieve the event object, and handling your own
internal events, as well as cleanup when the page is unloaded to clean up IE's
nasty memory leakage.</p>
<p>This event system is largely based on Qt's signal/slot system. Read more on
how that is handled and also how it is used in model/view programming at:
<a class="reference" href="http://doc.trolltech.com/">http://doc.trolltech.com/</a></p>
</div>
<div class="section">
<h1><a id="dependencies" name="dependencies">Dependencies</a></h1>
<ul class="simple">
<li><a class="mochiref reference" href="Base.html">MochiKit.Base</a></li>
<li><a class="mochiref reference" href="DOM.html">MochiKit.DOM</a></li>
</ul>
</div>
<div class="section">
<h1><a id="overview" name="overview">Overview</a></h1>
<div class="section">
<h2><a id="using-signal-for-dom-events" name="using-signal-for-dom-events">Using Signal for DOM Events</a></h2>
<p>When using MochiKit.Signal, do not use the browser's native event API. That
means, no <tt class="docutils literal"><span class="pre">onclick=&quot;blah&quot;</span></tt>, no <tt class="docutils literal"><span class="pre">elem.addEventListener(...)</span></tt>, and certainly
no <tt class="docutils literal"><span class="pre">elem.attachEvent(...)</span></tt>. This also means that
<a class="mochiref reference" href="DOM.html#fn-addtocallstack">MochiKit.DOM.addToCallStack</a> and
<a class="mochiref reference" href="DOM.html#fn-addloadevent">MochiKit.DOM.addLoadEvent</a> should not be used in combination with
this module.</p>
<p>Signals for DOM objects are named with the <tt class="docutils literal"><span class="pre">'on'</span></tt> prefix, e.g.:
<tt class="docutils literal"><span class="pre">'onclick'</span></tt>, <tt class="docutils literal"><span class="pre">'onkeyup'</span></tt>, etc.</p>
<p>When the signal fires, your slot will be called with one parameter, the custom
event object.</p>
</div>
<div class="section">
<h2><a id="custom-event-objects-for-dom-events" name="custom-event-objects-for-dom-events">Custom Event Objects for DOM events</a></h2>
<p>Signals triggered by DOM events are called with a custom event object as a
parameter. The custom event object presents a consistent view of the event
across all supported platforms and browsers, and provides many conveniences
not available even in a correct W3C implementation.</p>
<p>See the <a class="reference" href="#dom-custom-event-object-reference">DOM Custom Event Object Reference</a> for a detailed API description
of this object.</p>
<p>If you find that you're accessing the native event for any reason, create a
<a class="reference" href="http://trac.mochikit.com/newticket">new ticket</a> and we'll look into normalizing the behavior you're looking for.</p>
</div>
<div class="section">
<h2><a id="memory-usage" name="memory-usage">Memory Usage</a></h2>
<p>Any object that has connected slots (via <a class="mochiref reference" href="#fn-connect">connect()</a>) is referenced
by the Signal mechanism until it is disconnected via <a class="mochiref reference" href="#fn-disconnect">disconnect()</a>
or <a class="mochiref reference" href="#fn-disconnectall">disconnectAll()</a>.</p>
<p>Signal does not leak. It registers an <tt class="docutils literal"><span class="pre">'onunload'</span></tt> event that disconnects all
objects on the page when the browser leaves the page. However, memory usage
will grow during the page view for every connection made until it is
disconnected. Even if the DOM object is removed from the document, it
will still be referenced by Signal until it is explicitly disconnected.</p>
<p>In order to conserve memory during the page view, <a class="mochiref reference" href="#fn-disconnectall">disconnectAll()</a>
any DOM elements that are about to be removed from the document.</p>
</div>
<div class="section">
<h2><a id="using-signal-for-non-dom-objects" name="using-signal-for-non-dom-objects">Using Signal for non-DOM objects</a></h2>
<p>Signals are triggered with the <a class="mochiref reference" href="#fn-signal">signal(src, 'signal', ...)</a>
function. Additional parameters passed to this are passed onto the
connected slots. Explicit signals are not required for DOM events.</p>
<p>Slots that are connected to a signal are called in the following manner
when that signal is signalled:</p>
<ul class="simple">
<li>If the slot was a single function, then it is called with <tt class="docutils literal"><span class="pre">this</span></tt> set
to the object originating the signal with whatever parameters it was
signalled with.</li>
<li>If the slot was an object and a function, then it is called with
<tt class="docutils literal"><span class="pre">this</span></tt> set to the object, and with whatever parameters it was
signalled with.</li>
<li>If the slot was an object and a string, then <tt class="docutils literal"><span class="pre">object[string]</span></tt> is
called with the parameters to the signal.</li>
</ul>
</div>
</div>
<div class="section">
<h1><a id="api-reference" name="api-reference">API Reference</a></h1>
<div class="section">
<h2><a id="signal-api-reference" name="signal-api-reference">Signal API Reference</a></h2>
<p>
<a name="fn-connect"></a>
<a class="mochidef reference" href="#fn-connect">connect(src, signal, dest[, func])</a>:</p>
<blockquote>
<p>Connects a signal to a slot, and return a unique identifier that can be
used to disconnect that signal.</p>
<p><tt class="docutils literal"><span class="pre">src</span></tt> is the object that has the signal. You may pass in a string, in
which case, it is interpreted as an id for an HTML element.</p>
<p><tt class="docutils literal"><span class="pre">signal</span></tt> is a string that represents a signal name. If 'src' is an HTML
Element, <tt class="docutils literal"><span class="pre">window</span></tt>, or the <tt class="docutils literal"><span class="pre">document</span></tt>, then it can be one of the
'on-XYZ' events. You must include the 'on' prefix, and it must be all
lower-case.</p>
<p><tt class="docutils literal"><span class="pre">dest</span></tt> and <tt class="docutils literal"><span class="pre">func</span></tt> describe the slot, or the action to take when the
signal is triggered.</p>
<blockquote>
<ul class="simple">
<li>If <tt class="docutils literal"><span class="pre">dest</span></tt> is an object and <tt class="docutils literal"><span class="pre">func</span></tt> is a string, then
<tt class="docutils literal"><span class="pre">dest[func].apply(dest,</span> <span class="pre">...)</span></tt> will be called when the signal
is signalled.</li>
<li>If <tt class="docutils literal"><span class="pre">dest</span></tt> is an object and <tt class="docutils literal"><span class="pre">func</span></tt> is a function, then
<tt class="docutils literal"><span class="pre">func.apply(dest,</span> <span class="pre">...)</span></tt> will be called when the signal is
signalled.</li>
<li>If <tt class="docutils literal"><span class="pre">func</span></tt> is undefined and <tt class="docutils literal"><span class="pre">dest</span></tt> is a function, then
<tt class="docutils literal"><span class="pre">func.apply(src,</span> <span class="pre">...)</span></tt> will be called when the signal is
signalled.</li>
</ul>
</blockquote>
<p>No other combinations are allowed and will raise an exception.</p>
<p>The return value can be passed to <a class="mochiref reference" href="#fn-disconnect">disconnect</a> to disconnect
the signal.</p>
</blockquote>
<p>
<a name="fn-disconnect"></a>
<a class="mochidef reference" href="#fn-disconnect">disconnect(ident)</a>:</p>
<blockquote>
To disconnect a signal, pass its ident returned by <a class="mochiref reference" href="#fn-connect">connect()</a>.
This is similar to how the browser's <tt class="docutils literal"><span class="pre">setTimeout</span></tt> and <tt class="docutils literal"><span class="pre">clearTimeout</span></tt>
works.</blockquote>
<p>
<a name="fn-disconnectall"></a>
<a class="mochidef reference" href="#fn-disconnectall">disconnectAll(src[, signal, ...])</a>:</p>
<blockquote>
<p><tt class="docutils literal"><span class="pre">disconnectAll(src)</span></tt> removes all signals from src.</p>
<p><tt class="docutils literal"><span class="pre">disconnectAll(src,</span> <span class="pre">'onmousedown',</span> <span class="pre">'mySignal')</span></tt> will remove all
<tt class="docutils literal"><span class="pre">'onmousedown'</span></tt> and <tt class="docutils literal"><span class="pre">'mySignal'</span></tt> signals from src.</p>
</blockquote>
<p>
<a name="fn-signal"></a>
<a class="mochidef reference" href="#fn-signal">signal(src, signal, ...)</a>:</p>
<blockquote>
This will signal a signal, passing whatever additional parameters on to
the connected slots. <tt class="docutils literal"><span class="pre">src</span></tt> and <tt class="docutils literal"><span class="pre">signal</span></tt> are the same as for
<a class="mochiref reference" href="#fn-connect">connect()</a>.</blockquote>
</div>
<div class="section">
<h2><a id="dom-custom-event-object-reference" name="dom-custom-event-object-reference">DOM Custom Event Object Reference</a></h2>
<p>
<a name="fn-event"></a>
<a class="mochidef reference" href="#fn-event">event()</a>:</p>
<blockquote>
The native event produced by the browser. You should not need to use this.</blockquote>
<p>
<a name="fn-src"></a>
<a class="mochidef reference" href="#fn-src">src()</a>:</p>
<blockquote>
The element that this signal is connected to.</blockquote>
<p>
<a name="fn-type"></a>
<a class="mochidef reference" href="#fn-type">type()</a>:</p>
<blockquote>
The event type (<tt class="docutils literal"><span class="pre">'click'</span></tt>, <tt class="docutils literal"><span class="pre">'mouseover'</span></tt>, <tt class="docutils literal"><span class="pre">'keypress'</span></tt>, etc.) as a
string. Does not include the <tt class="docutils literal"><span class="pre">'on'</span></tt> prefix.</blockquote>
<p>
<a name="fn-target"></a>
<a class="mochidef reference" href="#fn-target">target()</a>:</p>
<blockquote>
The element that triggered the event. This may be a child of
<a class="mochiref reference" href="#fn-src">src()</a>.</blockquote>
<p>
<a name="fn-modifier"></a>
<a class="mochidef reference" href="#fn-modifier">modifier()</a>:</p>
<blockquote>
Returns <tt class="docutils literal"><span class="pre">{shift,</span> <span class="pre">ctrl,</span> <span class="pre">meta,</span> <span class="pre">alt,</span> <span class="pre">any}</span></tt>, where each property is <tt class="docutils literal"><span class="pre">true</span></tt>
if its respective modifier key was pressed, <tt class="docutils literal"><span class="pre">false</span></tt> otherwise. <tt class="docutils literal"><span class="pre">any</span></tt>
is <tt class="docutils literal"><span class="pre">true</span></tt> if any modifier is pressed, <tt class="docutils literal"><span class="pre">false</span></tt> otherwise.</blockquote>
<p>
<a name="fn-stoppropagation"></a>
<a class="mochidef reference" href="#fn-stoppropagation">stopPropagation()</a>:</p>
<blockquote>
Works like W3C's <tt class="docutils literal"><span class="pre">stopPropagation()</span></tt>.</blockquote>
<p>
<a name="fn-preventdefault"></a>
<a class="mochidef reference" href="#fn-preventdefault">preventDefault()</a>:</p>
<blockquote>
Works like W3C's <tt class="docutils literal"><span class="pre">preventDefault()</span></tt>.</blockquote>
<p>
<a name="fn-stop"></a>
<a class="mochidef reference" href="#fn-stop">stop()</a>:</p>
<blockquote>
Shortcut that calls <tt class="docutils literal"><span class="pre">stopPropagation()</span></tt> and <tt class="docutils literal"><span class="pre">preventDefault()</span></tt>.</blockquote>
<p>
<a name="fn-key"></a>
<a class="mochidef reference" href="#fn-key">key()</a>:</p>
<blockquote>
<p>Returns <tt class="docutils literal"><span class="pre">{code,</span> <span class="pre">string}</span></tt>.</p>
<p>Use <tt class="docutils literal"><span class="pre">'onkeydown'</span></tt> and <tt class="docutils literal"><span class="pre">'onkeyup'</span></tt> handlers to detect control
characters such as <tt class="docutils literal"><span class="pre">'KEY_F1'</span></tt>. Use the <tt class="docutils literal"><span class="pre">'onkeypressed'</span></tt> handler to
detect &quot;printable&quot; characters, such as <tt class="docutils literal"><span class="pre">'é'</span></tt>.</p>
<p>When a user presses F1, in <tt class="docutils literal"><span class="pre">'onkeydown'</span></tt> and <tt class="docutils literal"><span class="pre">'onkeyup'</span></tt> this method
returns <tt class="docutils literal"><span class="pre">{code:</span> <span class="pre">122,</span> <span class="pre">string:</span> <span class="pre">'KEY_F1'}</span></tt>. In <tt class="docutils literal"><span class="pre">'onkeypress'</span></tt>, it returns
<tt class="docutils literal"><span class="pre">{code:</span> <span class="pre">0,</span> <span class="pre">string:</span> <span class="pre">''}</span></tt>.</p>
<p>If a user presses Shift+2 on a US keyboard, this method returns
<tt class="docutils literal"><span class="pre">{code:</span> <span class="pre">50,</span> <span class="pre">string:</span> <span class="pre">'KEY_2'}</span></tt> in <tt class="docutils literal"><span class="pre">'onkeydown'</span></tt> and <tt class="docutils literal"><span class="pre">'onkeyup'</span></tt>.
In <tt class="docutils literal"><span class="pre">'onkeypress'</span></tt>, it returns <tt class="docutils literal"><span class="pre">{code:</span> <span class="pre">64,</span> <span class="pre">string:</span> <span class="pre">'&#64;'}</span></tt>.</p>
<p>See <tt class="docutils literal"><span class="pre">_specialKeys</span></tt> in the source code for a comprehensive list of
control characters.</p>
</blockquote>
<p>
<a name="fn-mouse"></a>
<a class="mochidef reference" href="#fn-mouse">mouse()</a>:</p>
<blockquote>
<p>Properties for <tt class="docutils literal"><span class="pre">'onmouse*'</span></tt>, <tt class="docutils literal"><span class="pre">'onclick'</span></tt>, <tt class="docutils literal"><span class="pre">'ondblclick'</span></tt>, and
<tt class="docutils literal"><span class="pre">'oncontextmenu'</span></tt>:</p>
<blockquote>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">page</span></tt> is a <a class="mochiref reference" href="DOM.html#fn-coordinates">MochiKit.DOM.Coordinates</a> object that
represents the cursor position relative to the HTML document.
Equivalent to <tt class="docutils literal"><span class="pre">pageX</span></tt> and <tt class="docutils literal"><span class="pre">pageY</span></tt> in Safari, Mozilla, and
Opera.</li>
<li><tt class="docutils literal"><span class="pre">client</span></tt> is a <a class="mochiref reference" href="DOM.html#fn-coordinates">MochiKit.DOM.Coordinates</a> object that
represents the cursor position relative to the visible portion of
the HTML document. Equivalent to <tt class="docutils literal"><span class="pre">clientX</span></tt> and <tt class="docutils literal"><span class="pre">clientY</span></tt> on
all browsers.</li>
</ul>
</blockquote>
<p>Properties for <tt class="docutils literal"><span class="pre">'onmouseup'</span></tt>, <tt class="docutils literal"><span class="pre">'onmousedown'</span></tt>, <tt class="docutils literal"><span class="pre">'onclick'</span></tt>, and
<tt class="docutils literal"><span class="pre">'ondblclick'</span></tt>:</p>
<blockquote>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">mouse().button</span></tt> returns <tt class="docutils literal"><span class="pre">{left,</span> <span class="pre">right,</span> <span class="pre">middle}</span></tt> where each
property is <tt class="docutils literal"><span class="pre">true</span></tt> if the mouse button was pressed, <tt class="docutils literal"><span class="pre">false</span></tt>
otherwise.</li>
</ul>
</blockquote>
<p>Known browser bugs:</p>
<blockquote>
<ul>
<li><p class="first">Current versions of Safari won't signal <tt class="docutils literal"><span class="pre">'ondblclick'</span></tt> when
attached via <tt class="docutils literal"><span class="pre">connect()</span></tt> (<a class="reference" href="http://bugzilla.opendarwin.org/show_bug.cgi?id=7790">Safari Bug 7790</a>).</p>
</li>
<li><p class="first">Mac browsers don't report right-click consistently. Firefox
signals the slot and sets <tt class="docutils literal"><span class="pre">modifier().ctrl</span></tt> to true, Opera
signals the slot and sets <tt class="docutils literal"><span class="pre">modifier().meta</span></tt> to <tt class="docutils literal"><span class="pre">true</span></tt>, and
Safari doesn't signal the slot at all (<a class="reference" href="http://bugzilla.opendarwin.org/show_bug.cgi?id=6595">Safari Bug 6595</a>).</p>
<p>To find a right-click in Safari, Firefox, and IE, you can connect
an element to <tt class="docutils literal"><span class="pre">'oncontextmenu'</span></tt>. This doesn't work in Opera.</p>
</li>
</ul>
</blockquote>
</blockquote>
<p>
<a name="fn-relatedtarget"></a>
<a class="mochidef reference" href="#fn-relatedtarget">relatedTarget()</a>:</p>
<blockquote>
Returns the document element that the mouse has moved to. This is
generated for <tt class="docutils literal"><span class="pre">'onmouseover'</span></tt> and <tt class="docutils literal"><span class="pre">'onmouseout'</span></tt> events.</blockquote>
</div>
</div>
<div class="section">
<h1><a id="authors" name="authors">Authors</a></h1>
<ul class="simple">
<li>Jonathan Gardner &lt;<a class="reference" href="mailto:jgardner&#64;jonathangardner.net">jgardner&#64;jonathangardner.net</a>&gt;</li>
<li>Beau Hartshorne &lt;<a class="reference" href="mailto:beau&#64;hartshornesoftware.com">beau&#64;hartshornesoftware.com</a>&gt;</li>
<li>Bob Ippolito &lt;<a class="reference" href="mailto:bob&#64;redivi.com">bob&#64;redivi.com</a>&gt;</li>
</ul>
</div>
<div class="section">
<h1><a id="copyright" name="copyright">Copyright</a></h1>
<p>Copyright 2006 Jonathan Gardner &lt;<a class="reference" href="mailto:jgardner&#64;jonathangardner.net">jgardner&#64;jonathangardner.net</a>&gt;, Beau
Hartshorne &lt;<a class="reference" href="mailto:beau&#64;hartshornesoftware.com">beau&#64;hartshornesoftware.com</a>&gt;, and Bob Ippolito &lt;<a class="reference" href="mailto:bob&#64;redivi.com">bob&#64;redivi.com</a>&gt;.
This program is dual-licensed free software; you can redistribute it and/or
modify it under the terms of the <a class="reference" href="http://www.opensource.org/licenses/mit-license.php">MIT License</a> or the
<a class="reference" href="http://www.opensource.org/licenses/afl-2.1.php">Academic Free License v2.1</a>.</p>
</div>
</div>
</body>
</html>

View File

@@ -1,264 +0,0 @@
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
<title></title>
<link rel="stylesheet" href="../../../include/css/documentation.css" type="text/css" />
<script type="text/javascript" src="../../../packed/lib/MochiKit/MochiKit.js"></script>
<script type="text/javascript" src="../../js/toc.js"></script>
</head>
<body>
<div class="document">
<p>2006-04-29 v1.3.1 (bug fix release)</p>
<ul class="simple">
<li>Fix sendXMLHttpRequest sendContent regression</li>
<li>Internet Explorer fix in MochiKit.Logging (printfire exception)</li>
<li>Internet Explorer XMLHttpRequest object leak fixed in MochiKit.Async</li>
</ul>
<p>2006-04-26 v1.3 &quot;warp zone&quot;</p>
<ul class="simple">
<li>IMPORTANT: Renamed MochiKit.Base.forward to forwardCall (for export)</li>
<li>IMPORTANT: Renamed MochiKit.Base.find to findValue (for export)</li>
<li>New MochiKit.Base.method as a convenience form of bind that takes the
object before the method</li>
<li>New MochiKit.Base.flattenArguments for flattening a list of arguments to
a single Array</li>
<li>Refactored MochiRegExp example to use MochiKit.Signal</li>
<li>New key_events example demonstrating use of MochiKit.Signal's key handling
capabilities.</li>
<li>MochiKit.DOM.createDOM API change for convenience: if attrs is a string,
null is used and the string will be considered the first node. This
allows for the more natural P(&quot;foo&quot;) rather than P(null, &quot;foo&quot;).</li>
<li>MochiKit Interpreter example refactored to use MochiKit.Signal and now
provides multi-line input and a help() function to get MochiKit function
signature from the documentation.</li>
<li>Native Console Logging for the default MochiKit.Logging logger</li>
<li>New MochiKit.Async.DeferredList, gatherResults, maybeDeferred</li>
<li>New MochiKit.Signal example: draggable</li>
<li>Added sanity checking to Deferred to ensure that errors happen when chaining
is used incorrectly</li>
<li>Opera sendXMLHttpRequest fix (sends empty string instead of null by default)</li>
<li>Fix a bug in MochiKit.Color that incorrectly generated hex colors for
component values smaller than 16/255.</li>
<li>Fix a bug in MochiKit.Logging that prevented logs from being capped at a
maximum size</li>
<li>MochiKit.Async.Deferred will now wrap thrown objects that are not instanceof
Error, so that the errback chain is used instead of the callback chain.</li>
<li>MochiKit.DOM.appendChildNodes and associated functions now append iterables
in the correct order.</li>
<li>New MochiKit-based SimpleTest test runner as a replacement for Test.Simple</li>
<li>MochiKit.Base.isNull no longer matches undefined</li>
<li>example doctypes changed to HTML4</li>
<li>isDateLike no longer throws error on null</li>
<li>New MochiKit.Signal module, modeled after the slot/signal mechanism in Qt</li>
<li>updated elementDimensions to calculate width from offsetWidth instead
of clientWidth</li>
<li>formContents now works with FORM tags that have a name attribute</li>
<li>Documentation now uses MochiKit to generate a function index</li>
</ul>
<p>2006-01-26 v1.2 &quot;the ocho&quot;</p>
<ul class="simple">
<li>Fixed MochiKit.Color.Color.lighterColorWithLevel</li>
<li>Added new MochiKit.Base.findIdentical function to find the index of an
element in an Array-like object. Uses === for identity comparison.</li>
<li>Added new MochiKit.Base.find function to find the index of an element in
an Array-like object. Uses compare for rich comparison.</li>
<li>MochiKit.Base.bind will accept a string for func, which will be immediately
looked up as self[func].</li>
<li>MochiKit.DOM.formContents no longer skips empty form elements for Zope
compatibility</li>
<li>MochiKit.Iter.forEach will now catch StopIteration to break</li>
<li>New MochiKit.DOM.elementDimensions(element) for determining the width and
height of an element in the document</li>
<li>MochiKit.DOM's initialization is now compatible with
HTMLUnit + JWebUnit + Rhino</li>
<li>MochiKit.LoggingPane will now re-use a <tt class="docutils literal"><span class="pre">_MochiKit_LoggingPane</span></tt> DIV element
currently in the document instead of always creating one.</li>
<li>MochiKit.Base now has operator.mul</li>
<li>MochiKit.DOM.formContents correctly handles unchecked checkboxes that have
a custom value attribute</li>
<li>Added new MochiKit.Color constructors fromComputedStyle and fromText</li>
<li>MochiKit.DOM.setNodeAttribute should work now</li>
<li>MochiKit.DOM now has a workaround for an IE bug when setting the style
property to a string</li>
<li>MochiKit.DOM.createDOM now has workarounds for IE bugs when setting the
name and for properties</li>
<li>MochiKit.DOM.scrapeText now walks the DOM tree in-order</li>
<li>MochiKit.LoggingPane now sanitizes the window name to work around IE bug</li>
<li>MochiKit.DOM now translates usemap to useMap to work around IE bug</li>
<li>MochiKit.Logging is now resistant to Prototype's dumb Object.prototype hacks</li>
<li>Added new MochiKit.DOM documentation on element visibility</li>
<li>New MochiKit.DOM.elementPosition(element[, relativeTo={x: 0, y: 0}])
for determining the position of an element in the document</li>
<li>Added new MochiKit.DOM createDOMFunc aliases: CANVAS, STRONG</li>
</ul>
<p>2005-11-14 v1.1</p>
<ul class="simple">
<li>Fixed a bug in numberFormatter with large numbers</li>
<li>Massively overhauled documentation</li>
<li>Fast-path for primitives in MochiKit.Base.compare</li>
<li>New groupby and groupby_as_array in MochiKit.Iter</li>
<li>Added iterator factory adapter for objects that implement iterateNext()</li>
<li>Fixed isoTimestamp to handle timestamps with time zone correctly</li>
<li>Added new MochiKit.DOM createDOMFunc aliases: SELECT, OPTION, OPTGROUP,
LEGEND, FIELDSET</li>
<li>New MochiKit.DOM formContents and enhancement to queryString to support it</li>
<li>Updated view_source example to use dp.SyntaxHighlighter 1.3.0</li>
<li>MochiKit.LoggingPane now uses named windows based on the URL so that
a given URL will get the same LoggingPane window after a reload
(at the same position, etc.)</li>
<li>MochiKit.DOM now has currentWindow() and currentDocument() context
variables that are set with withWindow() and withDocument(). These
context variables affect all MochiKit.DOM functionality (getElement,
createDOM, etc.)</li>
<li>MochiKit.Base.items will now catch and ignore exceptions for properties
that are enumerable but not accessible (e.g. permission denied)</li>
<li>MochiKit.Async.Deferred's addCallback/addErrback/addBoth
now accept additional arguments that are used to create a partially
applied function. This differs from Twisted in that the callback/errback
result becomes the <em>last</em> argument, not the first when this feature
is used.</li>
<li>MochiKit.Async's doSimpleXMLHttpRequest will now accept additional
arguments which are used to create a GET query string</li>
<li>Did some refactoring to reduce the footprint of MochiKit by a few
kilobytes</li>
<li>escapeHTML to longer escapes ' (apos) and now uses
String.replace instead of iterating over every char.</li>
<li>Added DeferredLock to Async</li>
<li>Renamed getElementsComputedStyle to computedStyle and moved
it from MochiKit.Visual to MochiKit.DOM</li>
<li>Moved all color support out of MochiKit.Visual and into MochiKit.Color</li>
<li>Fixed range() to accept a negative step</li>
<li>New alias to MochiKit.swapDOM called removeElement</li>
<li>New MochiKit.DOM.setNodeAttribute(node, attr, value) which sets
an attribute on a node without raising, roughly equivalent to:
updateNodeAttributes(node, {attr: value})</li>
<li>New MochiKit.DOM.getNodeAttribute(node, attr) which gets the value of
a node's attribute or returns null without raising</li>
<li>Fixed a potential IE memory leak if using MochiKit.DOM.addToCallStack
directly (addLoadEvent did not leak, since it clears the handler)</li>
</ul>
<p>2005-10-24 v1.0</p>
<ul class="simple">
<li>New interpreter example that shows usage of MochiKit.DOM to make
an interactive JavaScript interpreter</li>
<li>New MochiKit.LoggingPane for use with the MochiKit.Logging
debuggingBookmarklet, with logging_pane example to show its usage</li>
<li>New mochiregexp example that demonstrates MochiKit.DOM and MochiKit.Async
in order to provide a live regular expression matching tool</li>
<li>Added advanced number formatting capabilities to MochiKit.Format:
numberFormatter(pattern, placeholder=&quot;&quot;, locale=&quot;default&quot;) and
formatLocale(locale=&quot;default&quot;)</li>
<li>Added updatetree(self, obj[, ...]) to MochiKit.Base, and changed
MochiKit.DOM's updateNodeAttributes(node, attrs) to use it when appropiate.</li>
<li>Added new MochiKit.DOM createDOMFunc aliases: BUTTON, TT, PRE</li>
<li>Added truncToFixed(aNumber, precision) and roundToFixed(aNumber, precision)
to MochiKit.Format</li>
<li>MochiKit.DateTime can now handle full ISO 8601 timestamps, specifically
isoTimestamp(isoString) will convert them to Date objects, and
toISOTimestamp(date, true) will return an ISO 8601 timestamp in UTC</li>
<li>Fixed missing errback for sendXMLHttpRequest when the server does not
respond</li>
<li>Fixed infinite recusion bug when using roundClass(&quot;DIV&quot;, ...)</li>
<li>Fixed a bug in MochiKit.Async wait (and callLater) that prevented them
from being cancelled properly</li>
<li>Workaround in MochiKit.Base bind (and partial) for functions that don't
have an apply method, such as alert</li>
<li>Reliably return null from the string parsing/manipulation functions if
the input can't be coerced to a string (s + &quot;&quot;) or the input makes no sense;
e.g. isoTimestamp(null) and isoTimestamp(&quot;&quot;) return null</li>
</ul>
<p>2005-10-08 v0.90</p>
<ul class="simple">
<li>Fixed ISO compliance with toISODate</li>
<li>Added missing operator.sub</li>
<li>Placated Mozilla's strict warnings a bit</li>
<li>Added JSON serialization and unserialization support to MochiKit.Base:
serializeJSON, evalJSON, registerJSON. This is very similar to the repr
API.</li>
<li>Fixed a bug in the script loader that failed in some scenarios when a script
tag did not have a &quot;src&quot; attribute (thanks Ian!)</li>
<li>Added new MochiKit.DOM createDOMFunc aliases: H1, H2, H3, BR, HR, TEXTAREA,
P, FORM</li>
<li>Use encodeURIComponent / decodeURIComponent for MochiKit.Base urlEncode
and parseQueryString, when available.</li>
</ul>
<p>2005-08-12 v0.80</p>
<ul class="simple">
<li>Source highlighting in all examples, moved to a view-source example</li>
<li>Added some experimental syntax highlighting for the Rounded Corners example,
via the LGPL dp.SyntaxHighlighter 1.2.0 now included in examples/common/lib</li>
<li>Use an indirect binding for the logger conveniences, so that the global
logger could be replaced by setting MochiKit.Logger.logger to something else
(though an observer is probably a better choice).</li>
<li>Allow MochiKit.DOM.getElementsByTagAndClassName to take a string for parent,
which will be looked up with getElement</li>
<li>Fixed bug in MochiKit.Color.fromBackground (was using node.parent instead of
node.parentNode)</li>
<li>Consider a 304 (NOT_MODIFIED) response from XMLHttpRequest to be success</li>
<li>Disabled Mozilla map(...) fast-path due to Deer Park compatibility issues</li>
<li>Possible workaround for Safari issue with swapDOM, where it would get
confused because two elements were in the DOM at the same time with the
same id</li>
<li>Added missing THEAD convenience function to MochiKit.DOM</li>
<li>Added lstrip, rstrip, strip to MochiKit.Format</li>
<li>Added updateNodeAttributes, appendChildNodes, replaceChildNodes to
MochiKit.DOM</li>
<li>MochiKit.Iter.iextend now has a fast-path for array-like objects</li>
<li>Added HSV color space support to MochiKit.Visual</li>
<li>Fixed a bug in the sortable_tables example, it now converts types
correctly</li>
<li>Fixed a bug where MochiKit.DOM referenced MochiKit.Iter.next from global
scope</li>
</ul>
<p>2005-08-04 v0.70</p>
<ul class="simple">
<li>New ajax_tables example, which shows off XMLHttpRequest, ajax, json, and
a little TAL-ish DOM templating attribute language.</li>
<li>sendXMLHttpRequest and functions that use it (loadJSONDoc, etc.) no longer
ignore requests with status == 0, which seems to happen for cached or local
requests</li>
<li>Added sendXMLHttpRequest to MochiKit.Async.EXPORT, d'oh.</li>
<li>Changed scrapeText API to return a string by default. This is API-breaking!
It was dumb to have the default return value be the form you almost never
want. Sorry.</li>
<li>Added special form to swapDOM(dest, src). If src is null, dest is removed
(where previously you'd likely get a DOM exception).</li>
<li>Added three new functions to MochiKit.Base for dealing with URL query
strings: urlEncode, queryString, parseQueryString</li>
<li>MochiKit.DOM.createDOM will now use attr[k] = v for all browsers if the name
starts with &quot;on&quot; (e.g. &quot;onclick&quot;). If v is a string, it will set it to
new Function(v).</li>
<li>Another workaround for Internet &quot;worst browser ever&quot; Explorer's setAttribute
usage in MochiKit.DOM.createDOM (checked -&gt; defaultChecked).</li>
<li>Added UL, OL, LI convenience createDOM aliases to MochiKit.DOM</li>
<li>Packing is now done by Dojo's custom Rhino interpreter, so it's much smaller
now!</li>
</ul>
<p>2005-07-29 v0.60</p>
<ul class="simple">
<li>Beefed up the MochiKit.DOM test suite</li>
<li>Fixed return value for MochiKit.DOM.swapElementClass, could return
false unexpectedly before</li>
<li>Added an optional &quot;parent&quot; argument to
MochiKit.DOM.getElementsByTagAndClassName</li>
<li>Added a &quot;packed&quot; version in packed/lib/MochiKit/MochiKit.js</li>
<li>Changed build script to rewrite the URLs in tests to account for the
JSAN-required reorganization</li>
<li>MochiKit.Compat to potentially work around IE 5.5 issues
(5.0 still not supported). Test.Simple doesn't seem to work there,
though.</li>
<li>Several minor documentation corrections</li>
</ul>
<p>2005-07-27 v0.50</p>
<ul class="simple">
<li>Initial Release</li>
</ul>
</div>
</body>
</html>

View File

@@ -1,162 +0,0 @@
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
<title>MochiKit.Visual - visual effects</title>
<link rel="stylesheet" href="../../../include/css/documentation.css" type="text/css" />
<script type="text/javascript" src="../../../packed/lib/MochiKit/MochiKit.js"></script>
<script type="text/javascript" src="../../js/toc.js"></script>
</head>
<body>
<div class="document">
<div class="section">
<h1><a id="name" name="name">Name</a></h1>
<p>MochiKit.Visual - visual effects</p>
</div>
<div class="section">
<h1><a id="synopsis" name="synopsis">Synopsis</a></h1>
<pre class="literal-block">
// round the corners of all h1 elements
roundClass(&quot;h1&quot;, null);
// round the top left corner of the element with the id &quot;title&quot;
roundElement(&quot;title&quot;, {corners: &quot;tl&quot;});
</pre>
</div>
<div class="section">
<h1><a id="description" name="description">Description</a></h1>
<p>MochiKit.Visual provides visual effects and support functions for visuals.</p>
</div>
<div class="section">
<h1><a id="dependencies" name="dependencies">Dependencies</a></h1>
<ul class="simple">
<li><a class="mochiref reference" href="Base.html">MochiKit.Base</a></li>
<li><a class="mochiref reference" href="Iter.html">MochiKit.Iter</a></li>
<li><a class="mochiref reference" href="DOM.html">MochiKit.DOM</a></li>
<li><a class="mochiref reference" href="Color.html">MochiKit.Color</a></li>
</ul>
</div>
<div class="section">
<h1><a id="overview" name="overview">Overview</a></h1>
<p>At this time, MochiKit.Visual provides one visual effect: rounded corners
for your HTML elements. These rounded corners are created completely
through CSS manipulations and require no external images or style sheets.
This implementation was adapted from <a class="reference" href="http://www.openrico.org">Rico</a>.</p>
</div>
<div class="section">
<h1><a id="api-reference" name="api-reference">API Reference</a></h1>
<div class="section">
<h2><a id="functions" name="functions">Functions</a></h2>
<p>
<a name="fn-roundclass"></a>
<a class="mochidef reference" href="#fn-roundclass">roundClass(tagName[, className[, options]])</a>:</p>
<blockquote>
Rounds all of the elements that match the <tt class="docutils literal"><span class="pre">tagName</span></tt> and <tt class="docutils literal"><span class="pre">className</span></tt>
specifiers, using the options provided. <tt class="docutils literal"><span class="pre">tagName</span></tt> or <tt class="docutils literal"><span class="pre">className</span></tt> can
be <tt class="docutils literal"><span class="pre">null</span></tt> to match all tags or classes. For more information about
the options, see the <a class="mochiref reference" href="#fn-roundelement">roundElement</a> function.</blockquote>
<p>
<a name="fn-roundelement"></a>
<a class="mochidef reference" href="#fn-roundelement">roundElement(element[, options])</a>:</p>
<blockquote>
<p>Immediately round the corners of the specified element.
The element can be given as either a string
with the element ID, or as an element object.</p>
<p>The options mapping has the following defaults:</p>
<table border="1" class="docutils">
<colgroup>
<col width="35%" />
<col width="65%" />
</colgroup>
<tbody valign="top">
<tr><td>corners</td>
<td><tt class="docutils literal"><span class="pre">&quot;all&quot;</span></tt></td>
</tr>
<tr><td>color</td>
<td><tt class="docutils literal"><span class="pre">&quot;fromElement&quot;</span></tt></td>
</tr>
<tr><td>bgColor</td>
<td><tt class="docutils literal"><span class="pre">&quot;fromParent&quot;</span></tt></td>
</tr>
<tr><td>blend</td>
<td><tt class="docutils literal"><span class="pre">true</span></tt></td>
</tr>
<tr><td>border</td>
<td><tt class="docutils literal"><span class="pre">false</span></tt></td>
</tr>
<tr><td>compact</td>
<td><tt class="docutils literal"><span class="pre">false</span></tt></td>
</tr>
</tbody>
</table>
<p>corners:</p>
<blockquote>
<p>specifies which corners of the element should be rounded.
Choices are:</p>
<ul class="simple">
<li>all</li>
<li>top</li>
<li>bottom</li>
<li>tl (top left)</li>
<li>bl (bottom left)</li>
<li>tr (top right)</li>
<li>br (bottom right)</li>
</ul>
<dl class="docutils">
<dt>Example:</dt>
<dd><tt class="docutils literal"><span class="pre">&quot;tl</span> <span class="pre">br&quot;</span></tt>: top-left and bottom-right corners are rounded</dd>
</dl>
</blockquote>
<dl class="docutils">
<dt>blend:</dt>
<dd>specifies whether the color and background color should be blended
together to produce the border color.</dd>
</dl>
</blockquote>
</div>
</div>
<div class="section">
<h1><a id="see-also" name="see-also">See Also</a></h1>
<table class="docutils footnote" frame="void" id="id1" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a name="id1">[1]</a></td><td>Application Kit Reference - NSColor: <a class="reference" href="http://developer.apple.com/documentation/Cocoa/Reference/ApplicationKit/ObjC_classic/Classes/NSColor.html">http://developer.apple.com/documentation/Cocoa/Reference/ApplicationKit/ObjC_classic/Classes/NSColor.html</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id2" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a name="id2">[2]</a></td><td>SVG 1.0 color keywords: <a class="reference" href="http://www.w3.org/TR/SVG/types.html#ColorKeywords">http://www.w3.org/TR/SVG/types.html#ColorKeywords</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id3" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a name="id3">[3]</a></td><td>W3C CSS3 Color Module: <a class="reference" href="http://www.w3.org/TR/css3-color/#svg-color">http://www.w3.org/TR/css3-color/#svg-color</a></td></tr>
</tbody>
</table>
</div>
<div class="section">
<h1><a id="authors" name="authors">Authors</a></h1>
<ul class="simple">
<li>Kevin Dangoor &lt;<a class="reference" href="mailto:dangoor&#64;gmail.com">dangoor&#64;gmail.com</a>&gt;</li>
<li>Bob Ippolito &lt;<a class="reference" href="mailto:bob&#64;redivi.com">bob&#64;redivi.com</a>&gt;</li>
<li>Originally adapted from Rico &lt;<a class="reference" href="http://openrico.org/">http://openrico.org/</a>&gt; (though little remains)</li>
</ul>
</div>
<div class="section">
<h1><a id="copyright" name="copyright">Copyright</a></h1>
<p>Copyright 2005 Bob Ippolito &lt;<a class="reference" href="mailto:bob&#64;redivi.com">bob&#64;redivi.com</a>&gt;. This program is dual-licensed
free software; you can redistribute it and/or modify it under the terms of the
<a class="reference" href="http://www.opensource.org/licenses/mit-license.php">MIT License</a> or the <a class="reference" href="http://www.opensource.org/licenses/afl-2.1.php">Academic Free License v2.1</a>.</p>
<p>Portions adapted from <a class="reference" href="http://www.openrico.org">Rico</a> are available under the terms of the
<a class="reference" href="http://www.apache.org/licenses/LICENSE-2.0.html">Apache License, Version 2.0</a>.</p>
</div>
</div>
</body>
</html>

View File

@@ -1,319 +0,0 @@
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
<title>MochiKit Documentation Index</title>
<link rel="stylesheet" href="../../../include/css/documentation.css" type="text/css" />
<script type="text/javascript" src="../../../packed/lib/MochiKit/MochiKit.js"></script>
<script type="text/javascript" src="../../js/toc.js"></script>
</head>
<body>
<div class="document">
<div class="section">
<h1><a id="distribution" name="distribution">Distribution</a></h1>
<p>MochiKit - makes JavaScript suck a bit less</p>
<ul class="simple">
<li><a class="mochiref reference" href="Async.html">MochiKit.Async</a> - manage asynchronous tasks</li>
<li><a class="mochiref reference" href="Base.html">MochiKit.Base</a> - functional programming and useful comparisons</li>
<li><a class="mochiref reference" href="DOM.html">MochiKit.DOM</a> - painless DOM manipulation API</li>
<li><a class="mochiref reference" href="Color.html">MochiKit.Color</a> - color abstraction with CSS3 support</li>
<li><a class="mochiref reference" href="DateTime.html">MochiKit.DateTime</a> - &quot;what time is it anyway?&quot;</li>
<li><a class="mochiref reference" href="Format.html">MochiKit.Format</a> - string formatting goes here</li>
<li><a class="mochiref reference" href="Iter.html">MochiKit.Iter</a> - itertools for JavaScript; iteration made HARD,
and then easy</li>
<li><a class="mochiref reference" href="Logging.html">MochiKit.Logging</a> - we're all tired of <tt class="docutils literal"><span class="pre">alert()</span></tt></li>
<li><a class="mochiref reference" href="LoggingPane.html">MochiKit.LoggingPane</a> - interactive <a class="mochiref reference" href="Logging.html">MochiKit.Logging</a>
pane</li>
<li><a class="mochiref reference" href="Signal.html">MochiKit.Signal</a> - simple universal event handling</li>
<li><a class="mochiref reference" href="Visual.html">MochiKit.Visual</a> - visual effects</li>
</ul>
</div>
<div class="section">
<h1><a id="notes" name="notes">Notes</a></h1>
<p>To turn on MochiKit's compatibility mode, do this before loading MochiKit:</p>
<pre class="literal-block">
&lt;script type=&quot;text/javascript&quot;&gt;MochiKit = {__compat__: true};&lt;/script&gt;
</pre>
<p>When compatibility mode is on, you must use fully qualified names for all
MochiKit functions (e.g. <tt class="docutils literal"><span class="pre">MochiKit.Base.map(...)</span></tt>).</p>
</div>
<div class="section">
<h1><a id="screencasts" name="screencasts">Screencasts</a></h1>
<ul class="simple">
<li><a class="reference" href="http://mochikit.com/screencasts/MochiKit_Intro-1">MochiKit 1.1 Intro</a></li>
</ul>
</div>
<div class="section">
<h1><a id="see-also" name="see-also">See Also</a></h1>
<ul class="simple">
<li><a class="reference" href="http://groups.google.com/group/mochikit">Google Groups: MochiKit</a>: The official mailing list for discussions
related to development of and with MochiKit</li>
<li><a class="reference" href="http://mochikit.com/">mochikit.com</a>: MochiKit's home on the web</li>
<li><a class="reference" href="http://bob.pythonmac.org/">from __future__ import *</a>: Bob Ippolito's blog</li>
<li><a class="reference" href="http://openjsan.org/doc/b/bo/bob/lib/MochiKit/">MochiKit on JSAN</a>: the JSAN distribution page for MochiKit</li>
<li><a class="reference" href="http://del.icio.us/tag/mochikit">MochiKit tag on del.icio.us</a>: Recent bookmarks related to MochiKit</li>
<li><a class="reference" href="http://technorati.com/tag/mochikit">MochiKit tag on Technorati</a>: Recent blog entries related to MochiKit</li>
</ul>
</div>
<div class="section">
<h1><a id="version-history" name="version-history">Version History</a></h1>
<p>2006-04-29 v1.3.1 (bug fix release)</p>
<ul class="simple">
<li>Fix sendXMLHttpRequest sendContent regression</li>
<li>Internet Explorer fix in MochiKit.Logging (printfire exception)</li>
<li>Internet Explorer XMLHttpRequest object leak fixed in MochiKit.Async</li>
</ul>
<p>2006-04-26 v1.3 &quot;warp zone&quot;</p>
<ul class="simple">
<li>IMPORTANT: Renamed MochiKit.Base.forward to forwardCall (for export)</li>
<li>IMPORTANT: Renamed MochiKit.Base.find to findValue (for export)</li>
<li>New MochiKit.Base.method as a convenience form of bind that takes the
object before the method</li>
<li>New MochiKit.Base.flattenArguments for flattening a list of arguments to
a single Array</li>
<li>Refactored MochiRegExp example to use MochiKit.Signal</li>
<li>New key_events example demonstrating use of MochiKit.Signal's key handling
capabilities.</li>
<li>MochiKit.DOM.createDOM API change for convenience: if attrs is a string,
null is used and the string will be considered the first node. This
allows for the more natural P(&quot;foo&quot;) rather than P(null, &quot;foo&quot;).</li>
<li>MochiKit Interpreter example refactored to use MochiKit.Signal and now
provides multi-line input and a help() function to get MochiKit function
signature from the documentation.</li>
<li>Native Console Logging for the default MochiKit.Logging logger</li>
<li>New MochiKit.Async.DeferredList, gatherResults, maybeDeferred</li>
<li>New MochiKit.Signal example: draggable</li>
<li>Added sanity checking to Deferred to ensure that errors happen when chaining
is used incorrectly</li>
<li>Opera sendXMLHttpRequest fix (sends empty string instead of null by default)</li>
<li>Fix a bug in MochiKit.Color that incorrectly generated hex colors for
component values smaller than 16/255.</li>
<li>Fix a bug in MochiKit.Logging that prevented logs from being capped at a
maximum size</li>
<li>MochiKit.Async.Deferred will now wrap thrown objects that are not instanceof
Error, so that the errback chain is used instead of the callback chain.</li>
<li>MochiKit.DOM.appendChildNodes and associated functions now append iterables
in the correct order.</li>
<li>New MochiKit-based SimpleTest test runner as a replacement for Test.Simple</li>
<li>MochiKit.Base.isNull no longer matches undefined</li>
<li>example doctypes changed to HTML4</li>
<li>isDateLike no longer throws error on null</li>
<li>New MochiKit.Signal module, modeled after the slot/signal mechanism in Qt</li>
<li>updated elementDimensions to calculate width from offsetWidth instead
of clientWidth</li>
<li>formContents now works with FORM tags that have a name attribute</li>
<li>Documentation now uses MochiKit to generate a function index</li>
</ul>
<p>2006-01-26 v1.2 &quot;the ocho&quot;</p>
<ul class="simple">
<li>Fixed MochiKit.Color.Color.lighterColorWithLevel</li>
<li>Added new MochiKit.Base.findIdentical function to find the index of an
element in an Array-like object. Uses === for identity comparison.</li>
<li>Added new MochiKit.Base.find function to find the index of an element in
an Array-like object. Uses compare for rich comparison.</li>
<li>MochiKit.Base.bind will accept a string for func, which will be immediately
looked up as self[func].</li>
<li>MochiKit.DOM.formContents no longer skips empty form elements for Zope
compatibility</li>
<li>MochiKit.Iter.forEach will now catch StopIteration to break</li>
<li>New MochiKit.DOM.elementDimensions(element) for determining the width and
height of an element in the document</li>
<li>MochiKit.DOM's initialization is now compatible with
HTMLUnit + JWebUnit + Rhino</li>
<li>MochiKit.LoggingPane will now re-use a <tt class="docutils literal"><span class="pre">_MochiKit_LoggingPane</span></tt> DIV element
currently in the document instead of always creating one.</li>
<li>MochiKit.Base now has operator.mul</li>
<li>MochiKit.DOM.formContents correctly handles unchecked checkboxes that have
a custom value attribute</li>
<li>Added new MochiKit.Color constructors fromComputedStyle and fromText</li>
<li>MochiKit.DOM.setNodeAttribute should work now</li>
<li>MochiKit.DOM now has a workaround for an IE bug when setting the style
property to a string</li>
<li>MochiKit.DOM.createDOM now has workarounds for IE bugs when setting the
name and for properties</li>
<li>MochiKit.DOM.scrapeText now walks the DOM tree in-order</li>
<li>MochiKit.LoggingPane now sanitizes the window name to work around IE bug</li>
<li>MochiKit.DOM now translates usemap to useMap to work around IE bug</li>
<li>MochiKit.Logging is now resistant to Prototype's dumb Object.prototype hacks</li>
<li>Added new MochiKit.DOM documentation on element visibility</li>
<li>New MochiKit.DOM.elementPosition(element[, relativeTo={x: 0, y: 0}])
for determining the position of an element in the document</li>
<li>Added new MochiKit.DOM createDOMFunc aliases: CANVAS, STRONG</li>
</ul>
<p>2005-11-14 v1.1</p>
<ul class="simple">
<li>Fixed a bug in numberFormatter with large numbers</li>
<li>Massively overhauled documentation</li>
<li>Fast-path for primitives in MochiKit.Base.compare</li>
<li>New groupby and groupby_as_array in MochiKit.Iter</li>
<li>Added iterator factory adapter for objects that implement iterateNext()</li>
<li>Fixed isoTimestamp to handle timestamps with time zone correctly</li>
<li>Added new MochiKit.DOM createDOMFunc aliases: SELECT, OPTION, OPTGROUP,
LEGEND, FIELDSET</li>
<li>New MochiKit.DOM formContents and enhancement to queryString to support it</li>
<li>Updated view_source example to use dp.SyntaxHighlighter 1.3.0</li>
<li>MochiKit.LoggingPane now uses named windows based on the URL so that
a given URL will get the same LoggingPane window after a reload
(at the same position, etc.)</li>
<li>MochiKit.DOM now has currentWindow() and currentDocument() context
variables that are set with withWindow() and withDocument(). These
context variables affect all MochiKit.DOM functionality (getElement,
createDOM, etc.)</li>
<li>MochiKit.Base.items will now catch and ignore exceptions for properties
that are enumerable but not accessible (e.g. permission denied)</li>
<li>MochiKit.Async.Deferred's addCallback/addErrback/addBoth
now accept additional arguments that are used to create a partially
applied function. This differs from Twisted in that the callback/errback
result becomes the <em>last</em> argument, not the first when this feature
is used.</li>
<li>MochiKit.Async's doSimpleXMLHttpRequest will now accept additional
arguments which are used to create a GET query string</li>
<li>Did some refactoring to reduce the footprint of MochiKit by a few
kilobytes</li>
<li>escapeHTML to longer escapes ' (apos) and now uses
String.replace instead of iterating over every char.</li>
<li>Added DeferredLock to Async</li>
<li>Renamed getElementsComputedStyle to computedStyle and moved
it from MochiKit.Visual to MochiKit.DOM</li>
<li>Moved all color support out of MochiKit.Visual and into MochiKit.Color</li>
<li>Fixed range() to accept a negative step</li>
<li>New alias to MochiKit.swapDOM called removeElement</li>
<li>New MochiKit.DOM.setNodeAttribute(node, attr, value) which sets
an attribute on a node without raising, roughly equivalent to:
updateNodeAttributes(node, {attr: value})</li>
<li>New MochiKit.DOM.getNodeAttribute(node, attr) which gets the value of
a node's attribute or returns null without raising</li>
<li>Fixed a potential IE memory leak if using MochiKit.DOM.addToCallStack
directly (addLoadEvent did not leak, since it clears the handler)</li>
</ul>
<p>2005-10-24 v1.0</p>
<ul class="simple">
<li>New interpreter example that shows usage of MochiKit.DOM to make
an interactive JavaScript interpreter</li>
<li>New MochiKit.LoggingPane for use with the MochiKit.Logging
debuggingBookmarklet, with logging_pane example to show its usage</li>
<li>New mochiregexp example that demonstrates MochiKit.DOM and MochiKit.Async
in order to provide a live regular expression matching tool</li>
<li>Added advanced number formatting capabilities to MochiKit.Format:
numberFormatter(pattern, placeholder=&quot;&quot;, locale=&quot;default&quot;) and
formatLocale(locale=&quot;default&quot;)</li>
<li>Added updatetree(self, obj[, ...]) to MochiKit.Base, and changed
MochiKit.DOM's updateNodeAttributes(node, attrs) to use it when appropiate.</li>
<li>Added new MochiKit.DOM createDOMFunc aliases: BUTTON, TT, PRE</li>
<li>Added truncToFixed(aNumber, precision) and roundToFixed(aNumber, precision)
to MochiKit.Format</li>
<li>MochiKit.DateTime can now handle full ISO 8601 timestamps, specifically
isoTimestamp(isoString) will convert them to Date objects, and
toISOTimestamp(date, true) will return an ISO 8601 timestamp in UTC</li>
<li>Fixed missing errback for sendXMLHttpRequest when the server does not
respond</li>
<li>Fixed infinite recusion bug when using roundClass(&quot;DIV&quot;, ...)</li>
<li>Fixed a bug in MochiKit.Async wait (and callLater) that prevented them
from being cancelled properly</li>
<li>Workaround in MochiKit.Base bind (and partial) for functions that don't
have an apply method, such as alert</li>
<li>Reliably return null from the string parsing/manipulation functions if
the input can't be coerced to a string (s + &quot;&quot;) or the input makes no sense;
e.g. isoTimestamp(null) and isoTimestamp(&quot;&quot;) return null</li>
</ul>
<p>2005-10-08 v0.90</p>
<ul class="simple">
<li>Fixed ISO compliance with toISODate</li>
<li>Added missing operator.sub</li>
<li>Placated Mozilla's strict warnings a bit</li>
<li>Added JSON serialization and unserialization support to MochiKit.Base:
serializeJSON, evalJSON, registerJSON. This is very similar to the repr
API.</li>
<li>Fixed a bug in the script loader that failed in some scenarios when a script
tag did not have a &quot;src&quot; attribute (thanks Ian!)</li>
<li>Added new MochiKit.DOM createDOMFunc aliases: H1, H2, H3, BR, HR, TEXTAREA,
P, FORM</li>
<li>Use encodeURIComponent / decodeURIComponent for MochiKit.Base urlEncode
and parseQueryString, when available.</li>
</ul>
<p>2005-08-12 v0.80</p>
<ul class="simple">
<li>Source highlighting in all examples, moved to a view-source example</li>
<li>Added some experimental syntax highlighting for the Rounded Corners example,
via the LGPL dp.SyntaxHighlighter 1.2.0 now included in examples/common/lib</li>
<li>Use an indirect binding for the logger conveniences, so that the global
logger could be replaced by setting MochiKit.Logger.logger to something else
(though an observer is probably a better choice).</li>
<li>Allow MochiKit.DOM.getElementsByTagAndClassName to take a string for parent,
which will be looked up with getElement</li>
<li>Fixed bug in MochiKit.Color.fromBackground (was using node.parent instead of
node.parentNode)</li>
<li>Consider a 304 (NOT_MODIFIED) response from XMLHttpRequest to be success</li>
<li>Disabled Mozilla map(...) fast-path due to Deer Park compatibility issues</li>
<li>Possible workaround for Safari issue with swapDOM, where it would get
confused because two elements were in the DOM at the same time with the
same id</li>
<li>Added missing THEAD convenience function to MochiKit.DOM</li>
<li>Added lstrip, rstrip, strip to MochiKit.Format</li>
<li>Added updateNodeAttributes, appendChildNodes, replaceChildNodes to
MochiKit.DOM</li>
<li>MochiKit.Iter.iextend now has a fast-path for array-like objects</li>
<li>Added HSV color space support to MochiKit.Visual</li>
<li>Fixed a bug in the sortable_tables example, it now converts types
correctly</li>
<li>Fixed a bug where MochiKit.DOM referenced MochiKit.Iter.next from global
scope</li>
</ul>
<p>2005-08-04 v0.70</p>
<ul class="simple">
<li>New ajax_tables example, which shows off XMLHttpRequest, ajax, json, and
a little TAL-ish DOM templating attribute language.</li>
<li>sendXMLHttpRequest and functions that use it (loadJSONDoc, etc.) no longer
ignore requests with status == 0, which seems to happen for cached or local
requests</li>
<li>Added sendXMLHttpRequest to MochiKit.Async.EXPORT, d'oh.</li>
<li>Changed scrapeText API to return a string by default. This is API-breaking!
It was dumb to have the default return value be the form you almost never
want. Sorry.</li>
<li>Added special form to swapDOM(dest, src). If src is null, dest is removed
(where previously you'd likely get a DOM exception).</li>
<li>Added three new functions to MochiKit.Base for dealing with URL query
strings: urlEncode, queryString, parseQueryString</li>
<li>MochiKit.DOM.createDOM will now use attr[k] = v for all browsers if the name
starts with &quot;on&quot; (e.g. &quot;onclick&quot;). If v is a string, it will set it to
new Function(v).</li>
<li>Another workaround for Internet &quot;worst browser ever&quot; Explorer's setAttribute
usage in MochiKit.DOM.createDOM (checked -&gt; defaultChecked).</li>
<li>Added UL, OL, LI convenience createDOM aliases to MochiKit.DOM</li>
<li>Packing is now done by Dojo's custom Rhino interpreter, so it's much smaller
now!</li>
</ul>
<p>2005-07-29 v0.60</p>
<ul class="simple">
<li>Beefed up the MochiKit.DOM test suite</li>
<li>Fixed return value for MochiKit.DOM.swapElementClass, could return
false unexpectedly before</li>
<li>Added an optional &quot;parent&quot; argument to
MochiKit.DOM.getElementsByTagAndClassName</li>
<li>Added a &quot;packed&quot; version in packed/lib/MochiKit/MochiKit.js</li>
<li>Changed build script to rewrite the URLs in tests to account for the
JSAN-required reorganization</li>
<li>MochiKit.Compat to potentially work around IE 5.5 issues
(5.0 still not supported). Test.Simple doesn't seem to work there,
though.</li>
<li>Several minor documentation corrections</li>
</ul>
<p>2005-07-27 v0.50</p>
<ul class="simple">
<li>Initial Release</li>
</ul>
</div>
<div class="section">
<h1><a id="copyright" name="copyright">Copyright</a></h1>
<p>Copyright 2005 Bob Ippolito &lt;<a class="reference" href="mailto:bob&#64;redivi.com">bob&#64;redivi.com</a>&gt;. This program is dual-licensed
free software; you can redistribute it and/or modify it under the terms of the
<a class="reference" href="http://www.opensource.org/licenses/mit-license.php">MIT License</a> or the <a class="reference" href="http://www.opensource.org/licenses/afl-2.1.php">Academic Free License v2.1</a>.</p>
</div>
</div>
</body>
</html>

View File

@@ -1,89 +0,0 @@
function function_ref(fn) {
return A({"href": fn[1], "class": "mochiref reference"}, fn[0], BR());
};
function toggle_docs() {
toggleElementClass("invisible", "show_index", "function_index");
return false;
};
function create_toc() {
if (getElement("distribution")) {
return global_index();
}
if (getElement("api-reference")) {
return module_index();
}
};
function doXHTMLRequest(url) {
var req = getXMLHttpRequest();
if (req.overrideMimeType) {
req.overrideMimeType("text/xml");
}
req.open("GET", url, true);
return sendXMLHttpRequest(req).addCallback(function (res) {
return res.responseXML.documentElement;
});
};
function load_request(href, div, doc) {
var functions = withDocument(doc, spider_doc);
forEach(functions, function (func) {
// fix anchors
if (func[1].charAt(0) == "#") {
func[1] = href + func[1];
}
});
var showLink = A({"class": "force-pointer"}, "[+]");
var hideLink = A({"class": "force-pointer"}, "[\u2013]");
var functionIndex = DIV({"id": "function_index", "class": "invisible"},
hideLink,
P(null, map(function_ref, functions))
);
var toggleFunc = function (e) {
toggleElementClass("invisible", showLink, functionIndex);
};
connect(showLink, "onclick", toggleFunc);
connect(hideLink, "onclick", toggleFunc);
replaceChildNodes(div,
showLink,
functionIndex
);
};
function global_index() {
var distList = getElementsByTagAndClassName("ul")[0];
var bullets = getElementsByTagAndClassName("li", null, distList);
for (var i = 0; i < bullets.length; i++) {
var tag = bullets[i];
var firstLink = getElementsByTagAndClassName("a", "mochiref", tag)[0];
var href = getNodeAttribute(firstLink, "href");
var div = DIV(null, "[\u2026]");
appendChildNodes(tag, BR(), div);
var d = doXHTMLRequest(href).addCallback(load_request, href, div);
}
};
function spider_doc() {
return map(
function (tag) {
return [scrapeText(tag), getNodeAttribute(tag, "href")];
},
getElementsByTagAndClassName("a", "mochidef")
);
};
function module_index() {
var sections = getElementsByTagAndClassName("div", "section");
var ptr = sections[1];
var ref = DIV({"class": "section"},
H1(null, "Function Index"),
A({"id": "show_index", "href": "#", "onclick": toggle_docs}, "[show]"),
DIV({"id": "function_index", "class": "invisible"},
A({"href":"#", "onclick": toggle_docs}, "[hide]"),
P(null, map(function_ref, spider_doc()))));
ptr.parentNode.insertBefore(ref, ptr);
};
addLoadEvent(create_toc);

View File

@@ -1,573 +0,0 @@
.. title:: MochiKit.Async - manage asynchronous tasks
Name
====
MochiKit.Async - manage asynchronous tasks
Synopsis
========
::
var url = "/src/b/bo/bob/MochiKit.Async/META.json";
/*
META.json looks something like this:
{"name": "MochiKit", "version": "0.5"}
*/
var d = loadJSONDoc(url);
var gotMetadata = function (meta) {
if (MochiKit.Async.VERSION == meta.version) {
alert("You have the newest MochiKit.Async!");
} else {
alert("MochiKit.Async "
+ meta.version
+ " is available, upgrade!");
}
};
var metadataFetchFailed = function (err) {
alert("The metadata for MochiKit.Async could not be fetched :(");
};
d.addCallbacks(gotMetadata, metadataFetchFailed);
Description
===========
MochiKit.Async provides facilities to manage asynchronous
(as in AJAX [1]_) tasks. The model for asynchronous computation
used in this module is heavily inspired by Twisted [2]_.
Dependencies
============
- :mochiref:`MochiKit.Base`
Overview
========
Deferred
--------
The Deferred constructor encapsulates a single value that
is not available yet. The most important example of this
in the context of a web browser would be an ``XMLHttpRequest``
to a server. The importance of the Deferred is that it
allows a consistent API to be exposed for all asynchronous
computations that occur exactly once.
The producer of the Deferred is responsible for doing all
of the complicated work behind the scenes. This often
means waiting for a timer to fire, or waiting for an event
(e.g. ``onreadystatechange`` of ``XMLHttpRequest``).
It could also be coordinating several events (e.g.
``XMLHttpRequest`` with a timeout, or several Deferreds
(e.g. fetching a set of XML documents that should be
processed at the same time).
Since these sorts of tasks do not respond immediately, the
producer of the Deferred does the following steps before
returning to the consumer:
1. Create a ``new`` :mochiref:`Deferred();` object and keep a reference
to it, because it will be needed later when the value is
ready.
2. Setup the conditions to create the value requested (e.g.
create a new ``XMLHttpRequest``, set its
``onreadystatechange``).
3. Return the :mochiref:`Deferred` object.
Since the value is not yet ready, the consumer attaches
a function to the Deferred that will be called when the
value is ready. This is not unlike ``setTimeout``, or
other similar facilities you may already be familiar with.
The consumer can also attach an "errback" to the
:mochiref:`Deferred`, which is a callback for error handling.
When the value is ready, the producer simply calls
``myDeferred.callback(theValue)``. If an error occurred,
it should call ``myDeferred.errback(theValue)`` instead.
As soon as this happens, the callback that the consumer
attached to the :mochiref:`Deferred` is called with ``theValue``
as the only argument.
There are quite a few additional "advanced" features
baked into :mochiref:`Deferred`, such as cancellation and
callback chains, so take a look at the API
reference if you would like to know more!
API Reference
=============
Errors
------
:mochidef:`AlreadyCalledError`:
Thrown by a :mochiref:`Deferred` if ``.callback`` or
``.errback`` are called more than once.
:mochidef:`BrowserComplianceError`:
Thrown when the JavaScript runtime is not capable of performing
the given function. Currently, this happens if the browser
does not support ``XMLHttpRequest``.
:mochidef:`CancelledError`:
Thrown by a :mochiref:`Deferred` when it is cancelled,
unless a canceller is present and throws something else.
:mochidef:`GenericError`:
Results passed to ``.fail`` or ``.errback`` of a :mochiref:`Deferred`
are wrapped by this ``Error`` if ``!(result instanceof Error)``.
:mochidef:`XMLHttpRequestError`:
Thrown when an ``XMLHttpRequest`` does not complete successfully
for any reason. The ``req`` property of the error is the failed
``XMLHttpRequest`` object, and for convenience the ``number``
property corresponds to ``req.status``.
Constructors
------------
:mochidef:`Deferred()`:
Encapsulates a sequence of callbacks in response to a value that
may not yet be available. This is modeled after the Deferred class
from Twisted [3]_.
.. _`Twisted`: http://twistedmatrix.com/
Why do we want this? JavaScript has no threads, and even if it did,
threads are hard. Deferreds are a way of abstracting non-blocking
events, such as the final response to an ``XMLHttpRequest``.
The sequence of callbacks is internally represented as a list
of 2-tuples containing the callback/errback pair. For example,
the following call sequence::
var d = new Deferred();
d.addCallback(myCallback);
d.addErrback(myErrback);
d.addBoth(myBoth);
d.addCallbacks(myCallback, myErrback);
is translated into a :mochiref:`Deferred` with the following internal
representation::
[
[myCallback, null],
[null, myErrback],
[myBoth, myBoth],
[myCallback, myErrback]
]
The :mochiref:`Deferred` also keeps track of its current status (fired).
Its status may be one of the following three values:
===== ================================
Value Condition
===== ================================
-1 no value yet (initial condition)
0 success
1 error
===== ================================
A :mochiref:`Deferred` will be in the error state if one of the following
conditions are met:
1. The result given to callback or errback is "``instanceof Error``"
2. The callback or errback threw while executing. If the thrown object
is not ``instanceof Error``, it will be wrapped with
:mochiref:`GenericError`.
Otherwise, the :mochiref:`Deferred` will be in the success state. The state
of the :mochiref:`Deferred` determines the next element in the callback
sequence to run.
When a callback or errback occurs with the example deferred chain, something
equivalent to the following will happen (imagine that exceptions are caught
and returned as-is)::
// d.callback(result) or d.errback(result)
if (!(result instanceof Error)) {
result = myCallback(result);
}
if (result instanceof Error) {
result = myErrback(result);
}
result = myBoth(result);
if (result instanceof Error) {
result = myErrback(result);
} else {
result = myCallback(result);
}
The result is then stored away in case another step is added to the
callback sequence. Since the :mochiref:`Deferred` already has a value
available, any new callbacks added will be called immediately.
There are two other "advanced" details about this implementation that are
useful:
Callbacks are allowed to return :mochiref:`Deferred` instances,
so you can build complicated sequences of events with (relative) ease.
The creator of the :mochiref:`Deferred` may specify a canceller. The
canceller is a function that will be called if
:mochiref:`Deferred.prototype.cancel` is called before the
:mochiref:`Deferred` fires. You can use this to allow an
``XMLHttpRequest`` to be cleanly cancelled, for example. Note that
cancel will fire the :mochiref:`Deferred` with a
:mochiref:`CancelledError` (unless your canceller throws or returns
a different ``Error``), so errbacks should be prepared to handle that
``Error`` gracefully for cancellable :mochiref:`Deferred` instances.
:mochidef:`Deferred.prototype.addBoth(func)`:
Add the same function as both a callback and an errback as the
next element on the callback sequence. This is useful for code
that you want to guarantee to run, e.g. a finalizer.
If additional arguments are given, then ``func`` will be replaced
with :mochiref:`MochiKit.Base.partial.apply(null, arguments)`. This
differs from `Twisted`_, because the result of the callback or
errback will be the *last* argument passed to ``func``.
If ``func`` returns a :mochiref:`Deferred`, then it will be chained
(its value or error will be passed to the next callback). Note that
once the returned ``Deferred`` is chained, it can no longer accept new
callbacks.
:mochidef:`Deferred.prototype.addCallback(func[, ...])`:
Add a single callback to the end of the callback sequence.
If additional arguments are given, then ``func`` will be replaced
with :mochiref:`MochiKit.Base.partial.apply(null, arguments)`. This
differs from `Twisted`_, because the result of the callback will
be the *last* argument passed to ``func``.
If ``func`` returns a :mochiref:`Deferred`, then it will be chained
(its value or error will be passed to the next callback). Note that
once the returned ``Deferred`` is chained, it can no longer accept new
callbacks.
:mochidef:`Deferred.prototype.addCallbacks(callback, errback)`:
Add separate callback and errback to the end of the callback
sequence. Either callback or errback may be ``null``,
but not both.
If ``callback`` or ``errback`` returns a :mochiref:`Deferred`,
then it will be chained (its value or error will be passed to the
next callback). Note that once the returned ``Deferred`` is chained,
it can no longer accept new callbacks.
:mochidef:`Deferred.prototype.addErrback(func)`:
Add a single errback to the end of the callback sequence.
If additional arguments are given, then ``func`` will be replaced
with :mochiref:`MochiKit.Base.partial.apply(null, arguments)`. This
differs from `Twisted`_, because the result of the errback will
be the *last* argument passed to ``func``.
If ``func`` returns a :mochiref:`Deferred`, then it will be chained
(its value or error will be passed to the next callback). Note that
once the returned ``Deferred`` is chained, it can no longer accept new
callbacks.
:mochidef:`Deferred.prototype.callback([result])`:
Begin the callback sequence with a non-``Error`` result. Result
may be any value except for a :mochiref:`Deferred`.
Either ``.callback`` or ``.errback`` should
be called exactly once on a :mochiref:`Deferred`.
:mochidef:`Deferred.prototype.cancel()`:
Cancels a :mochiref:`Deferred` that has not yet received a value,
or is waiting on another :mochiref:`Deferred` as its value.
If a canceller is defined, the canceller is called.
If the canceller did not return an ``Error``, or there
was no canceller, then the errback chain is started
with :mochiref:`CancelledError`.
:mochidef:`Deferred.prototype.errback([result])`:
Begin the callback sequence with an error result.
Result may be any value except for a :mochiref:`Deferred`,
but if ``!(result instanceof Error)``, it will be wrapped
with :mochiref:`GenericError`.
Either ``.callback`` or ``.errback`` should
be called exactly once on a :mochidef:`Deferred`.
:mochidef:`DeferredLock()`:
A lock for asynchronous systems.
The ``locked`` property of a :mochiref:`DeferredLock` will be ``true`` if
it locked, ``false`` otherwise. Do not change this property.
:mochidef:`DeferredLock.prototype.acquire()`:
Attempt to acquire the lock. Returns a :mochiref:`Deferred` that fires on
lock acquisition with the :mochiref:`DeferredLock` as the value.
If the lock is locked, then the :mochiref:`Deferred` goes into a waiting
list.
:mochidef:`DeferredLock.prototype.release()`:
Release the lock. If there is a waiting list, then the first
:mochiref:`Deferred` in that waiting list will be called back.
:mochidef:`DeferredList(list, [fireOnOneCallback, fireOnOneErrback, consumeErrors, canceller])`:
Combine a list of :mochiref:`Deferred` into one. Track the callbacks and
return a list of (success, result) tuples, 'success' being a boolean
indicating whether result is a normal result or an error.
Once created, you have access to all :mochiref:`Deferred` methods, like
addCallback, addErrback, addBoth. The behaviour can be changed by the
following options:
``fireOnOneCallback``:
Flag for launching the callback once the first Deferred of the list
has returned.
``fireOnOneErrback``:
Flag for calling the errback at the first error of a Deferred.
``consumeErrors``:
Flag indicating that any errors raised in the Deferreds should be
consumed by the DeferredList.
Example::
// We need to fetch data from 2 different urls
var d1 = loadJSONDoc(url1);
var d2 = loadJSONDoc(url2);
var l1 = new DeferredList([d1, d2], false, false, true);
l1.addCallback(function (resultList) {
MochiKit.Base.map(function (result) {
if (result[0]) {
alert("Data is here: " + result[1]);
} else {
alert("Got an error: " + result[1]);
}
}, resultList);
});
Functions
---------
:mochidef:`callLater(seconds, func[, args...])`:
Call ``func(args...)`` after at least ``seconds`` seconds have elapsed.
This is a convenience method for::
func = partial.apply(extend(null, arguments, 1));
return wait(seconds).addCallback(function (res) { return func() });
Returns a cancellable :mochiref:`Deferred`.
:mochidef:`doSimpleXMLHttpRequest(url[, queryArguments...])`:
Perform a simple ``XMLHttpRequest`` and wrap it with a
:mochiref:`Deferred` that may be cancelled.
Note that currently, only ``200`` (OK) and ``304``
(NOT_MODIFIED) are considered success codes at this time, other
status codes will result in an errback with an ``XMLHttpRequestError``.
``url``:
The URL to GET
``queryArguments``:
If this function is called with more than one argument, a ``"?"``
and the result of :mochiref:`MochiKit.Base.queryString` with
the rest of the arguments are appended to the URL.
For example, this will do a GET request to the URL
``http://example.com?bar=baz``::
doSimpleXMLHttpRequest("http://example.com", {bar: "baz"});
*returns*:
:mochiref:`Deferred` that will callback with the ``XMLHttpRequest``
instance on success
:mochidef:`evalJSONRequest(req)`:
Evaluate a JSON [4]_ ``XMLHttpRequest``
``req``:
The request whose ``.responseText`` property is to be evaluated
*returns*:
A JavaScript object
:mochidef:`fail([result])`:
Return a :mochiref:`Deferred` that has already had ``.errback(result)``
called.
See ``succeed`` documentation for rationale.
``result``:
The result to give to :mochiref:`Deferred.prototype.errback(result)`.
*returns*:
A ``new`` :mochiref:`Deferred()`
:mochidef:`gatherResults(deferreds)`:
A convenience function that returns a :mochiref:`DeferredList`
from the given ``Array`` of :mochiref:`Deferred` instances
that will callback with an ``Array`` of just results when
they're available, or errback on the first array.
:mochidef:`getXMLHttpRequest()`:
Return an ``XMLHttpRequest`` compliant object for the current
platform.
In order of preference:
- ``new XMLHttpRequest()``
- ``new ActiveXObject('Msxml2.XMLHTTP')``
- ``new ActiveXObject('Microsoft.XMLHTTP')``
- ``new ActiveXObject('Msxml2.XMLHTTP.4.0')``
:mochidef:`maybeDeferred(func[, argument...])`:
Call a ``func`` with the given arguments and ensure the result is a
:mochiref:`Deferred`.
``func``:
The function to call.
*returns*:
A new :mochiref:`Deferred` based on the call to ``func``. If ``func``
does not naturally return a :mochiref:`Deferred`, its result or error
value will be wrapped by one.
:mochidef:`loadJSONDoc(url)`:
Do a simple ``XMLHttpRequest`` to a URL and get the response
as a JSON [4]_ document.
``url``:
The URL to GET
*returns*:
:mochiref:`Deferred` that will callback with the evaluated JSON [4]_
response upon successful ``XMLHttpRequest``
:mochidef:`sendXMLHttpRequest(req[, sendContent])`:
Set an ``onreadystatechange`` handler on an ``XMLHttpRequest`` object
and send it off. Will return a cancellable :mochiref:`Deferred` that will
callback on success.
Note that currently, only ``200`` (OK) and ``304``
(NOT_MODIFIED) are considered success codes at this time, other
status codes will result in an errback with an ``XMLHttpRequestError``.
``req``:
An preconfigured ``XMLHttpRequest`` object (open has been called).
``sendContent``:
Optional string or DOM content to send over the ``XMLHttpRequest``.
*returns*:
:mochiref:`Deferred` that will callback with the ``XMLHttpRequest``
instance on success.
:mochidef:`succeed([result])`:
Return a :mochiref:`Deferred` that has already had ``.callback(result)``
called.
This is useful when you're writing synchronous code to an asynchronous
interface: i.e., some code is calling you expecting a :mochiref:`Deferred`
result, but you don't actually need to do anything asynchronous. Just
return ``succeed(theResult)``.
See ``fail`` for a version of this function that uses a failing
:mochiref:`Deferred` rather than a successful one.
``result``:
The result to give to :mochiref:`Deferred.prototype.callback(result)`
*returns*:
a ``new`` :mochiref:`Deferred`
:mochidef:`wait(seconds[, res])`:
Return a new cancellable :mochiref:`Deferred` that will ``.callback(res)``
after at least ``seconds`` seconds have elapsed.
See Also
========
.. [1] AJAX, Asynchronous JavaScript and XML: http://en.wikipedia.org/wiki/AJAX
.. [2] Twisted, an event-driven networking framework written in Python: http://twistedmatrix.com/
.. [3] Twisted Deferred Reference: http://twistedmatrix.com/projects/core/documentation/howto/defer.html
.. [4] JSON, JavaScript Object Notation: http://json.org/
Authors
=======
- Bob Ippolito <bob@redivi.com>
Copyright
=========
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed
free software; you can redistribute it and/or modify it under the terms of the
`MIT License`_ or the `Academic Free License v2.1`_.
.. _`MIT License`: http://www.opensource.org/licenses/mit-license.php
.. _`Academic Free License v2.1`: http://www.opensource.org/licenses/afl-2.1.php

View File

@@ -1,481 +0,0 @@
.. title:: MochiKit.Color - color abstraction with CSS3 support
Name
====
MochiKit.Color - color abstraction with CSS3 support
Synopsis
========
::
// RGB color expressions are supported
assert(
objEqual(Color.whiteColor(), Color.fromString("rgb(255,100%, 255)"))
);
// So is instantiating directly from HSL or RGB values.
// Note that fromRGB and fromHSL take numbers between 0.0 and 1.0!
assert( objEqual(Color.fromRGB(1.0, 1.0, 1.0), Color.fromHSL(0.0, 0.0, 1.0) );
// Or even SVG color keyword names, as per CSS3!
assert( Color.fromString("aquamarine"), "#7fffd4" );
// NSColor-like colors built in
assert( Color.whiteColor().toHexString() == "#ffffff" );
Description
===========
MochiKit.Color is an abstraction for handling colors and strings that
represent colors.
Dependencies
============
- :mochiref:`MochiKit.Base`
Overview
========
MochiKit.Color provides an abstraction of RGB, HSL and HSV colors with alpha.
It supports parsing and generating of CSS3 colors, and has a full CSS3 (SVG)
color table.
All of the functionality in this module is exposed through a Color constructor
and its prototype, but a few of its internals are available for direct use at
module level.
API Reference
=============
Constructors
------------
:mochidef:`Color()`:
Represents a color. Component values should be integers between ``0.0``
and ``1.0``. You should use one of the :mochiref:`Color` factory
functions such as :mochiref:`Color.fromRGB`, :mochiref:`Color.fromHSL`,
etc. instead of constructing :mochiref:`Color` objects directly.
:mochiref:`Color` instances can be compared with
:mochiref:`MochiKit.Base.compare` (though ordering is on RGB, so is not
particularly meaningful except for equality), and the default ``toString``
implementation returns :mochiref:`Color.prototype.toHexString()`.
:mochiref:`Color` instances are immutable, and much of the architecture is
inspired by AppKit's NSColor [1]_
:mochidef:`Color.fromBackground(elem)`:
Returns a :mochiref:`Color` object based on the background of the provided
element. Equivalent to::
c = Color.fromComputedStyle(
elem, "backgroundColor", "background-color") || Color.whiteColor();
:mochidef:`Color.fromComputedStyle(elem, style, mozillaEquivalentCSS)`:
Returns a :mochiref:`Color` object based on the result of
:mochiref:`MochiKit.DOM.computedStyle(elem, style, mozillaEquivalentCSS)`
or ``null`` if not found.
:mochidef:`Color.fromHexString(hexString)`:
Returns a :mochiref:`Color` object from the given hexadecimal color string.
For example, ``"#FFFFFF"`` would return a :mochiref:`Color` with
RGB values ``[255/255, 255/255, 255/255]`` (white).
:mochidef:`Color.fromHSL(hue, saturation, lightness, alpha=1.0)`:
Return a :mochiref:`Color` object from the given ``hue``, ``saturation``,
``lightness`` values. Values should be numbers between ``0.0`` and
``1.0``.
If ``alpha`` is not given, then ``1.0`` (completely opaque) will be used.
Alternate form:
:mochiref:`Color.fromHSL({h: hue, s: saturation, l: lightness, a: alpha})`
:mochidef:`Color.fromHSLString(hslString)`:
Returns a :mochiref:`Color` object from the given decimal hsl color string.
For example, ``"hsl(0,0%,100%)"`` would return a :mochiref:`Color` with
HSL values ``[0/360, 0/360, 360/360]`` (white).
:mochidef:`Color.fromHSV(hue, saturation, value, alpha=1.0)`:
Return a :mochiref:`Color` object from the given ``hue``, ``saturation``,
``value`` values. Values should be numbers between ``0.0`` and
``1.0``.
If ``alpha`` is not given, then ``1.0`` (completely opaque) will be used.
Alternate form:
:mochiref:`Color.fromHSV({h: hue, s: saturation, v: value, a: alpha})`
:mochidef:`Color.fromName(colorName)`:
Returns a :mochiref:`Color` object corresponding to the given
SVG 1.0 color keyword name [2]_ as per the W3C CSS3
Color Module [3]_. ``"transparent"`` is also accepted
as a color name, and will return :mochiref:`Color.transparentColor()`.
:mochidef:`Color.fromRGB(red, green, blue, alpha=1.0)`:
Return a :mochiref:`Color` object from the given ``red``, ``green``,
``blue``, and ``alpha`` values. Values should be numbers between ``0``
and ``1.0``.
If ``alpha`` is not given, then ``1.0`` (completely opaque) will be used.
Alternate form:
:mochiref:`Color.fromRGB({r: red, g: green, b: blue, a: alpha})`
:mochidef:`Color.fromRGBString(rgbString)`:
Returns a :mochiref:`Color` object from the given decimal rgb color string.
For example, ``"rgb(255,255,255)"`` would return a :mochiref:`Color` with
RGB values ``[255/255, 255/255, 255/255]`` (white).
:mochidef:`Color.fromText(elem)`:
Returns a :mochiref:`Color` object based on the text color of the provided
element. Equivalent to::
c = Color.fromComputedStyle(elem, "color") || Color.whiteColor();
:mochidef:`Color.fromString(rgbOrHexString)`:
Returns a :mochiref:`Color` object from the given RGB, HSL, hex, or name.
Will return ``null`` if the string can not be parsed by any of these
methods.
See :mochiref:`Color.fromHexString`, :mochiref:`Color.fromRGBString`,
:mochiref:`Color.fromHSLString` and :mochiref:`Color.fromName` more
information.
:mochidef:`Color.namedColors()`:
Returns an object with properties for each SVG 1.0 color keyword
name [2]_ supported by CSS3 [3]_. Property names are the color keyword
name in lowercase, and the value is a string suitable for
:mochiref:`Color.fromString()`.
:mochidef:`Color.prototype.colorWithAlpha(alpha)`:
Return a new :mochiref:`Color` based on this color, but with the provided
``alpha`` value.
:mochidef:`Color.prototype.colorWithHue(hue)`:
Return a new :mochiref:`Color` based on this color, but with the provided
``hue`` value.
:mochidef:`Color.prototype.colorWithSaturation(saturation)`:
Return a new :mochiref:`Color` based on this color, but with the provided
``saturation`` value (using the HSL color model).
:mochidef:`Color.prototype.colorWithLightness(lightness)`:
Return a new :mochiref:`Color` based on this color, but with the provided
``lightness`` value.
:mochidef:`Color.prototype.darkerColorWithLevel(level)`:
Return a new :mochiref:`Color` based on this color, but darker by the given
``level`` (between ``0`` and ``1.0``).
:mochidef:`Color.prototype.lighterColorWithLevel(level)`:
Return a new :mochiref:`Color` based on this color, but lighter by the given
``level`` (between ``0`` and ``1.0``).
:mochidef:`Color.prototype.blendedColor(other, fraction=0.5)`:
Return a new :mochiref:`Color` whose RGBA component values are a weighted sum
of this color and ``other``. Each component of the returned color
is the ``fraction`` of other's value plus ``1 - fraction`` of this
color's.
:mochidef:`Color.prototype.isLight()`:
Return ``true`` if the lightness value of this color is greater than
``0.5``.
Note that ``alpha`` is ignored for this calculation (color components
are not premultiplied).
:mochidef:`Color.prototype.isDark()`:
Return ``true`` if the lightness value of this color is less than or
equal to ``0.5``.
Note that ``alpha`` is ignored for this calculation (color components
are not premultiplied).
:mochidef:`Color.prototype.toRGBString()`:
Return the decimal ``"rgb(red, green, blue)"`` string representation of this
color.
If the alpha component is not ``1.0`` (fully opaque), the
``"rgba(red, green, blue, alpha)"`` string representation will be used.
For example::
assert( Color.whiteColor().toRGBString() == "rgb(255,255,255)" );
:mochidef:`Color.prototype.toHSLString()`:
Return the decimal ``"hsl(hue, saturation, lightness)"``
string representation of this color.
If the alpha component is not ``1.0`` (fully opaque), the
``"hsla(hue, saturation, lightness, alpha)"`` string representation
will be used.
For example::
assert( Color.whiteColor().toHSLString() == "hsl(0,0,360)" );
:mochidef:`Color.prototype.toHexString()`:
Return the hexadecimal ``"#RRGGBB"`` string representation of this color.
Note that the alpha component is completely ignored for hexadecimal
string representations!
For example::
assert( Color.whiteColor().toHexString() == "#FFFFFF" );
:mochidef:`Color.prototype.asRGB()`:
Return the RGB (red, green, blue, alpha) components of this color as an
object with ``r``, ``g``, ``b``, and ``a`` properties that have
values between ``0.0`` and ``1.0``.
:mochidef:`Color.prototype.asHSL()`:
Return the HSL (hue, saturation, lightness, alpha) components of this
color as an object with ``h``, ``s``, ``l`` and ``a`` properties
that have values between ``0.0`` and ``1.0``.
:mochidef:`Color.prototype.asHSV()`:
Return the HSV (hue, saturation, value, alpha) components of this
color as an object with ``h``, ``s``, ``v`` and ``a`` properties
that have values between ``0.0`` and ``1.0``.
:mochidef:`Color.blackColor()`:
Return a :mochiref:`Color` object whose RGB values are 0, 0, 0
(#000000).
:mochidef:`Color.blueColor()`:
Return a :mochiref:`Color` object whose RGB values are 0, 0, 1
(#0000ff).
:mochidef:`Color.brownColor()`:
Return a :mochiref:`Color` object whose RGB values are 0.6, 0.4, 0.2
(#996633).
:mochidef:`Color.cyanColor()`:
Return a :mochiref:`Color` object whose RGB values are 0, 1, 1
(#00ffff).
:mochidef:`Color.darkGrayColor()`:
Return a :mochiref:`Color` object whose RGB values are 1/3, 1/3, 1/3
(#555555).
:mochidef:`Color.grayColor()`:
Return a :mochiref:`Color` object whose RGB values are 0.5, 0.5, 0.5
(#808080).
:mochidef:`Color.greenColor()`:
Return a :mochiref:`Color` object whose RGB values are 0, 1, 0.
(#00ff00).
:mochidef:`Color.lightGrayColor()`:
Return a :mochiref:`Color` object whose RGB values are 2/3, 2/3, 2/3
(#aaaaaa).
:mochidef:`Color.magentaColor()`:
Return a :mochiref:`Color` object whose RGB values are 1, 0, 1
(#ff00ff).
:mochidef:`Color.orangeColor()`:
Return a :mochiref:`Color` object whose RGB values are 1, 0.5, 0
(#ff8000).
:mochidef:`Color.purpleColor()`:
Return a :mochiref:`Color` object whose RGB values are 0.5, 0, 0.5
(#800080).
:mochidef:`Color.redColor()`:
Return a :mochiref:`Color` object whose RGB values are 1, 0, 0
(#ff0000).
:mochidef:`Color.whiteColor()`:
Return a :mochiref:`Color` object whose RGB values are 1, 1, 1
(#ffffff).
:mochidef:`Color.yellowColor()`:
Return a :mochiref:`Color` object whose RGB values are 1, 1, 0
(#ffff00).
:mochidef:`Color.transparentColor()`:
Return a :mochiref:`Color` object that is completely transparent
(has alpha component of 0).
Functions
---------
:mochidef:`clampColorComponent(num, scale)`:
Returns ``num * scale`` clamped between ``0`` and ``scale``.
:mochiref:`clampColorComponent` is not exported by default when using JSAN.
:mochidef:`hslToRGB(hue, saturation, lightness, alpha)`:
Computes RGB values from the provided HSL values. The return value is a
mapping with ``"r"``, ``"g"``, ``"b"`` and ``"a"`` keys.
Alternate form:
:mochiref:`hslToRGB({h: hue, s: saturation, l: lightness, a: alpha})`.
:mochiref:`hslToRGB` is not exported by default when using JSAN.
:mochidef:`hsvToRGB(hue, saturation, value, alpha)`:
Computes RGB values from the provided HSV values. The return value is a
mapping with ``"r"``, ``"g"``, ``"b"`` and ``"a"`` keys.
Alternate form:
:mochiref:`hsvToRGB({h: hue, s: saturation, v: value, a: alpha})`.
:mochiref:`hsvToRGB` is not exported by default when using JSAN.
:mochidef:`toColorPart(num)`:
Convert num to a zero padded hexadecimal digit for use in a hexadecimal
color string. Num should be an integer between ``0`` and ``255``.
:mochiref:`toColorPart` is not exported by default when using JSAN.
:mochidef:`rgbToHSL(red, green, blue, alpha)`:
Computes HSL values based on the provided RGB values. The return value is
a mapping with ``"h"``, ``"s"``, ``"l"`` and ``"a"`` keys.
Alternate form:
:mochiref:`rgbToHSL({r: red, g: green, b: blue, a: alpha})`.
:mochiref:`rgbToHSL` is not exported by default when using JSAN.
:mochidef:`rgbToHSV(red, green, blue, alpha)`:
Computes HSV values based on the provided RGB values. The return value is
a mapping with ``"h"``, ``"s"``, ``"v"`` and ``"a"`` keys.
Alternate form:
:mochiref:`rgbToHSV({r: red, g: green, b: blue, a: alpha})`.
:mochiref:`rgbToHSV` is not exported by default when using JSAN.
See Also
========
.. [1] Application Kit Reference - NSColor: http://developer.apple.com/documentation/Cocoa/Reference/ApplicationKit/ObjC_classic/Classes/NSColor.html
.. [2] SVG 1.0 color keywords: http://www.w3.org/TR/SVG/types.html#ColorKeywords
.. [3] W3C CSS3 Color Module: http://www.w3.org/TR/css3-color/#svg-color
Authors
=======
- Bob Ippolito <bob@redivi.com>
Copyright
=========
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed
free software; you can redistribute it and/or modify it under the terms of the
`MIT License`_ or the `Academic Free License v2.1`_.
.. _`MIT License`: http://www.opensource.org/licenses/mit-license.php
.. _`Academic Free License v2.1`: http://www.opensource.org/licenses/afl-2.1.php

View File

@@ -1,782 +0,0 @@
.. title:: MochiKit.DOM - painless DOM manipulation API
Name
====
MochiKit.DOM - painless DOM manipulation API
Synopsis
========
::
var rows = [
["dataA1", "dataA2", "dataA3"],
["dataB1", "dataB2", "dataB3"]
];
row_display = function (row) {
return TR(null, map(partial(TD, null), row));
}
var newTable = TABLE({'class': 'prettytable'},
THEAD(null,
row_display(["head1", "head2", "head3"])),
TFOOT(null,
row_display(["foot1", "foot2", "foot3"])),
TBODY(null,
map(row_display, rows)));
// put that in your document.createElement and smoke it!
swapDOM(oldTable, newTable);
Description
===========
As you probably know, the DOM APIs are some of the most painful Java-inspired
APIs you'll run across from a highly dynamic language. Don't worry about that
though, because they provide a reasonable basis to build something that
sucks a lot less.
MochiKit.DOM takes much of its inspiration from Nevow's [1]_ stan [2]_.
This means you choose a tag, give it some attributes, then stuff it full
of *whatever objects you want*. MochiKit.DOM isn't stupid, it knows that
a string should be a text node, and that you want functions to be called,
and that ``Array``-like objects should be expanded, and stupid ``null`` values
should be skipped.
Hell, it will let you return strings from functions, and use iterators from
:mochiref:`MochiKit.Iter`. If that's not enough, just teach it new tricks with
:mochiref:`registerDOMConverter`. If you have never used an API like this for
creating DOM elements, you've been wasting your damn time. Get with it!
Dependencies
============
- :mochiref:`MochiKit.Base`
- :mochiref:`MochiKit.Iter`
Overview
========
DOM Coercion Rules
------------------
In order of precedence, :mochiref:`createDOM` coerces given arguments to DOM
nodes using the following rules:
1. Functions are called with a ``this`` of the parent
node and their return value is subject to the
following rules (even this one).
2. ``undefined`` and ``null`` are ignored.
3. Iterables (see :mochiref:`MochiKit.Iter`) are flattened
(as if they were passed in-line as nodes) and each
return value is subject to all of these rules.
4. Values that look like DOM nodes (objects with a
``.nodeType > 0``) are ``.appendChild``'ed to the created
DOM fragment.
5. Strings are wrapped up with ``document.createTextNode``
6. Objects that are not strings are run through the ``domConverters``
:mochiref:`MochiKit.Base.AdapterRegistry`
(see :mochiref:`registerDOMConverter`).
The value returned by the adapter is subject to these same rules (e.g.
adapters are allowed to return a string, which will be coerced into a
text node).
7. If no adapter is available, ``.toString()`` is used to create a text node.
Creating DOM Element Trees
--------------------------
:mochiref:`createDOM` provides you with an excellent facility for creating DOM trees
that is easy on the wrists. One of the best ways to understand how to use
it is to take a look at an example::
var rows = [
["dataA1", "dataA2", "dataA3"],
["dataB1", "dataB2", "dataB3"]
];
row_display = function (row) {
return TR(null, map(partial(TD, null), row));
}
var newTable = TABLE({'class': 'prettytable'},
THEAD(null,
row_display(["head1", "head2", "head3"])),
TFOOT(null,
row_display(["foot1", "foot2", "foot3"])),
TBODY(null,
map(row_display, rows)));
This will create a table with the following visual layout (if it
were inserted into the document DOM):
+--------+--------+--------+
| head1 | head2 | head3 |
+========+========+========+
| dataA1 | dataA2 | dataA3 |
+--------+--------+--------+
| dataB1 | dataB2 | dataB3 |
+--------+--------+--------+
| foot1 | foot2 | foot3 |
+--------+--------+--------+
Corresponding to the following HTML::
<table class="prettytable">
<thead>
<tr>
<td>head1</td>
<td>head2</td>
<td>head3</td>
</tr>
</thead>
<tfoot>
<tr>
<td>foot1</td>
<td>foot2</td>
<td>foot3</td>
</tr>
</tfoot>
<tbody>
<tr>
<td>dataA1</td>
<td>dataA2</td>
<td>dataA3</td>
</tr>
<tr>
<td>dataB1</td>
<td>dataB2</td>
<td>dataB3</td>
</tr>
</tbody>
</table>
DOM Context
-----------
In order to prevent having to pass a ``window`` and/or ``document``
variable to every MochiKit.DOM function (e.g. when working with a
child window), MochiKit.DOM maintains a context variable for each
of them. They are managed with the :mochiref:`withWindow` and
:mochiref:`withDocument` functions, and can be acquired with
:mochiref:`currentWindow()` and :mochiref:`currentDocument()`
For example, if you are creating DOM nodes in a child window, you
could do something like this::
withWindow(child, function () {
var doc = currentDocument();
appendChildNodes(doc.body, H1(null, "This is in the child!"));
});
Note that :mochiref:`withWindow(win, ...)` also implies
:mochiref:`withDocument(win.document, ...)`.
Element Visibility
------------------
The :mochiref:`hideElement` and :mochiref:`showElement` functions are
provided as a convenience, but only work for elements that are
``display: block``. For a general solution to showing, hiding, and checking
the explicit visibility of elements, we recommend using a solution that
involves a little CSS. Here's an example::
<style type="text/css">
.invisible { display: none; }
</style>
<script type="text/javascript">
function toggleVisible(elem) {
toggleElementClass("invisible", elem);
}
function makeVisible(elem) {
removeElementClass(elem, "invisible");
}
function makeInvisible(elem) {
addElementClass(elem, "invisible");
}
function isVisible(elem) {
// you may also want to check for
// getElement(elem).style.display == "none"
return !hasElementClass(elem, "invisible");
};
</script>
MochiKit doesn't ship with such a solution, because there is no reliable and
portable method for adding CSS rules on the fly with JavaScript.
API Reference
=============
Functions
---------
:mochidef:`$(id[, ...])`:
An alias for :mochiref:`getElement(id[, ...])`
:mochidef:`addElementClass(element, className)`:
Ensure that the given ``element`` has ``className`` set as part of its
class attribute. This will not disturb other class names.
``element`` is looked up with :mochiref:`getElement`, so string identifiers
are also acceptable.
:mochidef:`addLoadEvent(func)`:
Note that :mochiref:`addLoadEvent` can not be used in combination with
:mochiref:`MochiKit.Signal` if the ``onload`` event is connected.
Once an event is connected with :mochiref:`MochiKit.Signal`, no other APIs
may be used for that same event.
This will stack ``window.onload`` functions on top of each other.
Each function added will be called after ``onload`` in the
order that they were added.
:mochidef:`addToCallStack(target, path, func[, once])`:
Note that :mochiref:`addToCallStack` is not compatible with
:mochiref:`MochiKit.Signal`. Once an event is connected with
:mochiref:`MochiKit.Signal`, no other APIs may be used for that same event.
Set the property ``path`` of ``target`` to a function that calls the
existing function at that property (if any), then calls ``func``.
If ``target[path]()`` returns exactly ``false``, then ``func`` will
not be called.
If ``once`` is ``true``, then ``target[path]`` is set to ``null`` after
the function call stack has completed.
If called several times for the same ``target[path]``, it will create
a stack of functions (instead of just a pair).
:mochidef:`appendChildNodes(node[, childNode[, ...]])`:
Append children to a DOM element using the `DOM Coercion Rules`_.
``node``:
A reference to the DOM element to add children to
(if a string is given, :mochiref:`getElement(node)`
will be used to locate the node)
``childNode``...:
All additional arguments, if any, will be coerced into DOM
nodes that are appended as children using the
`DOM Coercion Rules`_.
*returns*:
The given DOM element
:mochidef:`computedStyle(htmlElement, cssProperty, mozillaEquivalentCSS)`:
Looks up a CSS property for the given element. The element can be
specified as either a string with the element's ID or the element
object itself.
:mochidef:`createDOM(name[, attrs[, node[, ...]]])`:
Create a DOM fragment in a really convenient manner, much like
Nevow`s [1]_ stan [2]_.
Partially applied versions of this function for common tags are
available as aliases:
- ``A``
- ``BUTTON``
- ``BR``
- ``CANVAS``
- ``DIV``
- ``FIELDSET``
- ``FORM``
- ``H1``
- ``H2``
- ``H3``
- ``HR``
- ``IMG``
- ``INPUT``
- ``LABEL``
- ``LEGEND``
- ``LI``
- ``OL``
- ``OPTGROUP``
- ``OPTION``
- ``P``
- ``PRE``
- ``SELECT``
- ``SPAN``
- ``STRONG``
- ``TABLE``
- ``TBODY``
- ``TD``
- ``TEXTAREA``
- ``TFOOT``
- ``TH``
- ``THEAD``
- ``TR``
- ``TT``
- ``UL``
See `Creating DOM Element Trees`_ for a comprehensive example.
``name``:
The kind of fragment to create (e.g. 'span'), such as you would
pass to ``document.createElement``.
``attrs``:
An object whose properties will be used as the attributes
(e.g. ``{'style': 'display:block'}``), or ``null`` if no
attributes need to be set.
See :mochiref:`updateNodeAttributes` for more information.
For convenience, if ``attrs`` is a string, ``null`` is used
and the string will be considered the first ``node``.
``node``...:
All additional arguments, if any, will be coerced into DOM
nodes that are appended as children using the
`DOM Coercion Rules`_.
*returns*:
A DOM element
:mochidef:`createDOMFunc(tag[, attrs[, node[, ...]]])`:
Convenience function to create a partially applied createDOM
function. You'd want to use this if you add additional convenience
functions for creating tags, or if you find yourself creating
a lot of tags with a bunch of the same attributes or contents.
See :mochiref:`createDOM` for more detailed descriptions of the arguments.
``tag``:
The name of the tag
``attrs``:
Optionally specify the attributes to apply
``node``...:
Optionally specify any children nodes it should have
*returns*:
function that takes additional arguments and calls
:mochiref:`createDOM`
:mochidef:`currentDocument()`:
Return the current ``document`` `DOM Context`_. This will always
be the same as the global ``document`` unless :mochiref:`withDocument` or
:mochiref:`withWindow` is currently executing.
:mochidef:`currentWindow()`:
Return the current ``window`` `DOM Context`_. This will always
be the same as the global ``window`` unless :mochiref:`withWindow` is
currently executing.
:mochidef:`elementDimensions(element)`:
Return the absolute pixel width and height of ``element`` as an object with
``w`` and ``h`` properties, or ``undefined`` if ``element`` is not in the
document. ``element`` may be specified as a string to be looked up with
:mochiref:`getElement`, a DOM element, or trivially as an object with
``w`` and/or ``h`` properties.
:mochidef:`elementPosition(element[, relativeTo={x: 0, y: 0}])`:
Return the absolute pixel position of ``element`` in the document as an
object with ``x`` and ``y`` properties, or ``undefined`` if ``element``
is not in the document. ``element`` may be specified as a string to
be looked up with :mochiref:`getElement`, a DOM element, or trivially
as an object with ``x`` and/or ``y`` properties.
If ``relativeTo`` is given, then its coordinates are subtracted from
the absolute position of ``element``, e.g.::
var elemPos = elementPosition(elem);
var anotherElemPos = elementPosition(anotherElem);
var relPos = elementPosition(elem, anotherElem);
assert( relPos.x == (elemPos.x - anotherElemPos.x) );
assert( relPos.y == (elemPos.y - anotherElemPos.y) );
``relativeTo`` may be specified as a string to be looked up with
:mochiref:`getElement`, a DOM element, or trivially as an object
with ``x`` and/or ``y`` properties.
:mochidef:`emitHTML(dom[, lst])`:
Convert a DOM tree to an ``Array`` of HTML string fragments
You probably want to use :mochiref:`toHTML` instead.
:mochidef:`escapeHTML(s)`:
Make a string safe for HTML, converting the usual suspects (lt,
gt, quot, apos, amp)
:mochidef:`focusOnLoad(element)`:
Add an onload event to focus the given element
:mochidef:`formContents(elem)`:
Search the DOM tree, starting at ``elem``, for any elements with a
``name`` and ``value`` attribute. Return a 2-element ``Array`` of
``names`` and ``values`` suitable for use with
:mochiref:`MochiKit.Base.queryString`.
:mochidef:`getElement(id[, ...])`:
A small quick little function to encapsulate the ``getElementById``
method. It includes a check to ensure we can use that method.
If the id isn't a string, it will be returned as-is.
Also available as :mochiref:`$(...)` for convenience and compatibility with
other JavaScript frameworks.
If multiple arguments are given, an ``Array`` will be returned.
:mochidef:`getElementsByTagAndClassName(tagName, className, parent=document)`:
Returns an array of elements in ``parent`` that match the tag name
and class name provided. If ``parent`` is a string, it will be looked
up with :mochiref:`getElement`.
If ``tagName`` is ``null`` or ``"*"``, all elements will be searched
for the matching class.
If ``className`` is ``null``, all elements matching the provided tag are
returned.
:mochidef:`getNodeAttribute(node, attr)`:
Get the value of the given attribute for a DOM element without
ever raising an exception (will return ``null`` on exception).
``node``:
A reference to the DOM element to update (if a string is given,
:mochiref:`getElement(node)` will be used to locate the node)
``attr``:
The name of the attribute
Note that it will do the right thing for IE, so don't do
the ``class`` -> ``className`` hack yourself.
*returns*:
The attribute's value, or ``null``
:mochidef:`getViewportDimensions()`:
Return the pixel width and height of the viewport as an object with ``w``
and ``h`` properties. ``element`` is looked up with
:mochiref:`getElement`, so string identifiers are also acceptable.
:mochidef:`hasElementClass(element, className[, ...])`:
Return ``true`` if ``className`` is found on the ``element``.
``element`` is looked up with :mochiref:`getElement`, so string identifiers
are also acceptable.
:mochidef:`hideElement(element, ...)`:
Partial form of :mochiref:`setDisplayForElement`, specifically::
partial(setDisplayForElement, "none")
For information about the caveats of using a ``style.display`` based
show/hide mechanism, and a CSS based alternative, see
`Element Visibility`_.
:mochidef:`registerDOMConverter(name, check, wrap[, override])`:
Register an adapter to convert objects that match ``check(obj, ctx)``
to a DOM element, or something that can be converted to a DOM
element (i.e. number, bool, string, function, iterable).
:mochidef:`removeElement(node)`:
Remove and return ``node`` from a DOM tree. This is technically
just a convenience for :mochiref:`swapDOM(node, null)`.
``node``:
the DOM element (or string id of one) to be removed
*returns*
The removed element
:mochidef:`removeElementClass(element, className)`:
Ensure that the given ``element`` does not have ``className`` set as part
of its class attribute. This will not disturb other class names.
``element`` is looked up with :mochiref:`getElement`, so string identifiers
are also acceptable.
:mochidef:`replaceChildNodes(node[, childNode[, ...]])`:
Remove all children from the given DOM element, then append any given
childNodes to it (by calling :mochiref:`appendChildNodes`).
``node``:
A reference to the DOM element to add children to
(if a string is given, :mochiref:`getElement(node)`
will be used to locate the node)
``childNode``...:
All additional arguments, if any, will be coerced into DOM
nodes that are appended as children using the
`DOM Coercion Rules`_.
*returns*:
The given DOM element
:mochidef:`scrapeText(node[, asArray=false])`:
Walk a DOM tree in-order and scrape all of the text out of it as a
``string``.
If ``asArray`` is ``true``, then an ``Array`` will be returned with
each individual text node. These two are equivalent::
assert( scrapeText(node) == scrapeText(node, true).join("") );
:mochidef:`setDisplayForElement(display, element[, ...])`:
Change the ``style.display`` for the given element(s). Usually
used as the partial forms:
- :mochiref:`showElement(element, ...)`
- :mochiref:`hideElement(element, ...)`
Elements are looked up with :mochiref:`getElement`, so string identifiers
are acceptable.
For information about the caveats of using a ``style.display`` based
show/hide mechanism, and a CSS based alternative, see
`Element Visibility`_.
:mochidef:`setElementClass(element, className)`:
Set the entire class attribute of ``element`` to ``className``.
``element`` is looked up with :mochiref:`getElement`, so string identifiers
are also acceptable.
:mochidef:`setElementDimensions(element, dimensions[, units='px'])`:
Sets the dimensions of ``element`` in the document from an
object with ``w`` and ``h`` properties.
``node``:
A reference to the DOM element to update (if a string is given,
:mochiref:`getElement(node)` will be used to locate the node)
``dimensions``:
An object with ``w`` and ``h`` properties
``units``:
Optionally set the units to use, default is ``px``
:mochidef:`setElementPosition(element, position[, units='px'])`:
Sets the absolute position of ``element`` in the document from an
object with ``x`` and ``y`` properties.
``node``:
A reference to the DOM element to update (if a string is given,
:mochiref:`getElement(node)` will be used to locate the node)
``position``:
An object with ``x`` and ``y`` properties
``units``:
Optionally set the units to use, default is ``px``
:mochidef:`setNodeAttribute(node, attr, value)`:
Set the value of the given attribute for a DOM element without
ever raising an exception (will return null on exception). If
setting more than one attribute, you should use
:mochiref:`updateNodeAttributes`.
``node``:
A reference to the DOM element to update (if a string is given,
:mochiref:`getElement(node)` will be used to locate the node)
``attr``:
The name of the attribute
Note that it will do the right thing for IE, so don't do
the ``class`` -> ``className`` hack yourself.
``value``:
The value of the attribute, may be an object to be merged
(e.g. for setting style).
*returns*:
The given DOM element or ``null`` on failure
:mochidef:`setOpacity(element, opacity)`:
Sets ``opacity`` for ``element``. Valid ``opacity`` values range from 0
(invisible) to 1 (opaque). ``element`` is looked up with
:mochiref:`getElement`, so string identifiers are also acceptable.
:mochidef:`showElement(element, ...)`:
Partial form of :mochiref:`setDisplayForElement`, specifically::
partial(setDisplayForElement, "block")
For information about the caveats of using a ``style.display`` based
show/hide mechanism, and a CSS based alternative, see
`Element Visibility`_.
:mochidef:`swapDOM(dest, src)`:
Replace ``dest`` in a DOM tree with ``src``, returning ``src``.
``dest``:
a DOM element (or string id of one) to be replaced
``src``:
the DOM element (or string id of one) to replace it with, or
``null`` if ``dest`` is to be removed (replaced with nothing).
*returns*:
a DOM element (``src``)
:mochidef:`swapElementClass(element, fromClass, toClass)`:
If ``fromClass`` is set on ``element``, replace it with ``toClass``.
This will not disturb other classes on that element.
``element`` is looked up with :mochiref:`getElement`, so string identifiers
are also acceptable.
:mochidef:`toggleElementClass(className[, element[, ...]])`:
Toggle the presence of a given ``className`` in the class attribute
of all given elements. All elements will be looked up with
:mochiref:`getElement`, so string identifiers are acceptable.
:mochidef:`toHTML(dom)`:
Convert a DOM tree to a HTML string using :mochiref:`emitHTML`
:mochidef:`updateNodeAttributes(node, attrs)`:
Update the attributes of a DOM element from a given object.
``node``:
A reference to the DOM element to update (if a string is given,
:mochiref:`getElement(node)` will be used to locate the node)
``attrs``:
An object whose properties will be used to set the attributes
(e.g. ``{'class': 'invisible'}``), or ``null`` if no
attributes need to be set. If an object is given for the
attribute value (e.g. ``{'style': {'display': 'block'}}``)
then :mochiref:`MochiKit.Base.updatetree` will be used to set that
attribute.
Note that it will do the right thing for IE, so don't do
the ``class`` -> ``className`` hack yourself, and it deals with
setting "on..." event handlers correctly.
*returns*:
The given DOM element
:mochidef:`withWindow(win, func)`:
Call ``func`` with the ``window`` `DOM Context`_ set to ``win`` and
the ``document`` `DOM Context`_ set to ``win.document``. When
``func()`` returns or throws an error, the `DOM Context`_ will be
restored to its previous state.
The return value of ``func()`` is returned by this function.
:mochidef:`withDocument(doc, func)`:
Call ``func`` with the ``doc`` `DOM Context`_ set to ``doc``.
When ``func()`` returns or throws an error, the `DOM Context`_
will be restored to its previous state.
The return value of ``func()`` is returned by this function.
See Also
========
.. [1] Nevow, a web application construction kit for Python: http://nevow.com/
.. [2] nevow.stan is a domain specific language for Python
(read as "crazy getitem/call overloading abuse") that Donovan and I
schemed up at PyCon 2003 at this super ninja Python/C++ programmer's
(David Abrahams) hotel room. Donovan later inflicted this upon the
masses in Nevow. Check out the Divmod project page for some
examples: http://nevow.com/Nevow2004Tutorial.html
Authors
=======
- Bob Ippolito <bob@redivi.com>
Copyright
=========
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed
free software; you can redistribute it and/or modify it under the terms of the
`MIT License`_ or the `Academic Free License v2.1`_.
.. _`MIT License`: http://www.opensource.org/licenses/mit-license.php
.. _`Academic Free License v2.1`: http://www.opensource.org/licenses/afl-2.1.php

View File

@@ -1,118 +0,0 @@
.. title:: MochiKit.DateTime - "what time is it anyway?"
Name
====
MochiKit.DateTime - "what time is it anyway?"
Synopsis
========
::
stringDate = toISOTimestamp(new Date());
dateObject = isoTimestamp(stringDate);
Description
===========
Remote servers don't give you JavaScript Date objects, and they certainly
don't want them from you, so you need to deal with string representations
of dates and timestamps. MochiKit.Date does that.
Dependencies
============
None.
API Reference
=============
Functions
---------
:mochidef:`isoDate(str)`:
Convert an ISO 8601 date (YYYY-MM-DD) to a ``Date`` object.
:mochidef:`isoTimestamp(str)`:
Convert any ISO 8601 [1]_ timestamp (or something reasonably close to it)
to a ``Date`` object. Will accept the "de facto" form:
YYYY-MM-DD hh:mm:ss
or (the proper form):
YYYY-MM-DDThh:mm:ssZ
If a time zone designator ("Z" or "[+-]HH:MM") is not present, then the
local timezone is used.
:mochidef:`toISOTime(date)`:
Convert a ``Date`` object to a string in the form of hh:mm:ss
:mochidef:`toISOTimestamp(date, realISO=false)`:
Convert a ``Date`` object to something that's ALMOST but not quite an
ISO 8601 [1]_timestamp. If it was a proper ISO timestamp it would be:
YYYY-MM-DDThh:mm:ssZ
However, we see junk in SQL and other places that looks like this:
YYYY-MM-DD hh:mm:ss
So, this function returns the latter form, despite its name, unless
you pass ``true`` for ``realISO``.
:mochidef:`toISODate(date)`:
Convert a ``Date`` object to an ISO 8601 [1]_ date string (YYYY-MM-DD)
:mochidef:`americanDate(str)`:
Converts a MM/DD/YYYY date to a ``Date`` object
:mochidef:`toPaddedAmericanDate(date)`:
Converts a ``Date`` object to an MM/DD/YYYY date, e.g. 01/01/2001
:mochidef:`toAmericanDate(date)`:
Converts a ``Date`` object to an M/D/YYYY date, e.g. 1/1/2001
See Also
========
.. [1] W3C profile of ISO 8601: http://www.w3.org/TR/NOTE-datetime
Authors
=======
- Bob Ippolito <bob@redivi.com>
Copyright
=========
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed
free software; you can redistribute it and/or modify it under the terms of the
`MIT License`_ or the `Academic Free License v2.1`_.
.. _`MIT License`: http://www.opensource.org/licenses/mit-license.php
.. _`Academic Free License v2.1`: http://www.opensource.org/licenses/afl-2.1.php

View File

@@ -1,211 +0,0 @@
.. title:: MochiKit.Format - string formatting goes here
Name
====
MochiKit.Format - string formatting goes here
Synopsis
========
::
assert( truncToFixed(0.12345, 4) == "0.1234" );
assert( roundToFixed(0.12345, 4) == "0.1235" );
assert( twoDigitAverage(1, 0) == "0" );
assert( twoDigitFloat(1.2345) == "1.23" );
assert( twoDigitFloat(1) == "1" );
assert( percentFormat(1.234567) == "123.46%" );
assert( numberFormatter("###,###%")(125) == "12,500%" );
assert( numberFormatter("##.000")(1.25) == "1.250" );
Description
===========
Formatting strings and stringifying numbers is boring, so a couple useful
functions in that domain live here.
Dependencies
============
None.
Overview
========
Formatting Numbers
------------------
MochiKit provides an extensible number formatting facility, modeled loosely
after the Number Format Pattern Syntax [1]_ from Java.
:mochiref:`numberFormatter(pattern[, placeholder=""[, locale="default"])`
returns a function that converts Number to string using the given information.
``pattern`` is a string consisting of the following symbols:
+-----------+---------------------------------------------------------------+
| Symbol | Meaning |
+===========+===============================================================+
| ``-`` | If given, used as the position of the minus sign |
| | for negative numbers. If not given, the position |
| | to the left of the first number placeholder is used. |
+-----------+---------------------------------------------------------------+
| ``#`` | The placeholder for a number that does not imply zero |
| | padding. |
+-----------+---------------------------------------------------------------+
| ``0`` | The placeholder for a number that implies zero padding. |
| | If it is used to the right of a decimal separator, it |
| | implies trailing zeros, otherwise leading zeros. |
+-----------+---------------------------------------------------------------+
| ``,`` | The placeholder for a "thousands separator". May be used |
| | at most once, and it must be to the left of a decimal |
| | separator. Will be replaced by ``locale.separator`` in the |
| | result (the default is also ``,``). |
+-----------+---------------------------------------------------------------+
| ``.`` | The decimal separator. The quantity of ``#`` or ``0`` |
| | after the decimal separator will determine the precision of |
| | the result. If no decimal separator is present, the |
| | fractional precision is ``0`` -- meaning that it will be |
| | rounded to the nearest integer. |
+-----------+---------------------------------------------------------------+
| ``%`` | If present, the number will be multiplied by ``100`` and |
| | the ``%`` will be replaced by ``locale.percent``. |
+-----------+---------------------------------------------------------------+
API Reference
=============
Functions
---------
:mochidef:`formatLocale(locale="default")`:
Return a locale object for the given locale. ``locale`` may be either a
string, which is looked up in the ``MochiKit.Format.LOCALE`` object, or
a locale object. If no locale is given, ``LOCALE.default`` is used
(equivalent to ``LOCALE.en_US``).
:mochidef:`lstrip(str, chars="\\s")`:
Returns a string based on ``str`` with leading whitespace stripped.
If ``chars`` is given, then that expression will be used instead of
whitespace. ``chars`` should be a string suitable for use in a ``RegExp``
``[character set]``.
:mochidef:`numberFormatter(pattern, placeholder="", locale="default")`:
Return a function ``formatNumber(aNumber)`` that formats numbers
as a string according to the given pattern, placeholder and locale.
``pattern`` is a string that describes how the numbers should be formatted,
for more information see `Formatting Numbers`_.
``locale`` is a string of a known locale (en_US, de_DE, fr_FR, default) or
an object with the following fields:
+-----------+-----------------------------------------------------------+
| separator | The "thousands" separator for this locale (en_US is ",") |
+-----------+-----------------------------------------------------------+
| decimal | The decimal separator for this locale (en_US is ".") |
+-----------+-----------------------------------------------------------+
| percent | The percent symbol for this locale (en_US is "%") |
+-----------+-----------------------------------------------------------+
:mochidef:`percentFormat(someFloat)`:
Roughly equivalent to: ``sprintf("%.2f%%", someFloat * 100)``
In new code, you probably want to use:
:mochiref:`numberFormatter("#.##%")(someFloat)` instead.
:mochidef:`roundToFixed(aNumber, precision)`:
Return a string representation of ``aNumber``, rounded to ``precision``
digits with trailing zeros. This is similar to
``Number.toFixed(aNumber, precision)``, but this has implementation
consistent rounding behavior (some versions of Safari round 0.5 down!)
and also includes preceding ``0`` for numbers less than ``1`` (Safari,
again).
For example, :mochiref:`roundToFixed(0.1357, 2)` returns ``0.14`` on every
supported platform, where some return ``.13`` for ``(0.1357).toFixed(2)``.
:mochidef:`rstrip(str, chars="\\s")`:
Returns a string based on ``str`` with trailing whitespace stripped.
If ``chars`` is given, then that expression will be used instead of
whitespace. ``chars`` should be a string suitable for use in a ``RegExp``
``[character set]``.
:mochidef:`strip(str, chars="\\s")`:
Returns a string based on ``str`` with leading and trailing whitespace
stripped (equivalent to :mochiref:`lstrip(rstrip(str, chars), chars)`).
If ``chars`` is given, then that expression will be used instead of
whitespace. ``chars`` should be a string suitable for use in a ``RegExp``
``[character set]``.
:mochidef:`truncToFixed(aNumber, precision)`:
Return a string representation of ``aNumber``, truncated to ``precision``
digits with trailing zeros. This is similar to
``aNumber.toFixed(precision)``, but this truncates rather than rounds and
has implementation consistent behavior for numbers less than 1.
Specifically, :mochiref:`truncToFixed(aNumber, precision)` will always have a
preceding ``0`` for numbers less than ``1``.
For example, :mochiref:`toFixed(0.1357, 2)` returns ``0.13``.
:mochidef:`twoDigitAverage(numerator, denominator)`:
Calculate an average from a numerator and a denominator and return
it as a string with two digits of precision (e.g. "1.23").
If the denominator is 0, "0" will be returned instead of ``NaN``.
:mochidef:`twoDigitFloat(someFloat)`:
Roughly equivalent to: ``sprintf("%.2f", someFloat)``
In new code, you probably want to use
:mochiref:`numberFormatter("#.##")(someFloat)` instead.
See Also
========
.. [1] Java Number Format Pattern Syntax:
http://java.sun.com/docs/books/tutorial/i18n/format/numberpattern.html
Authors
=======
- Bob Ippolito <bob@redivi.com>
Copyright
=========
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed
free software; you can redistribute it and/or modify it under the terms of the
`MIT License`_ or the `Academic Free License v2.1`_.
.. _`MIT License`: http://www.opensource.org/licenses/mit-license.php
.. _`Academic Free License v2.1`: http://www.opensource.org/licenses/afl-2.1.php

View File

@@ -1,345 +0,0 @@
.. title:: MochiKit.Iter - itertools for JavaScript; iteration made HARD, and then easy
Name
====
MochiKit.Iter - itertools for JavaScript; iteration made HARD, and then easy
Synopsis
========
::
theSum = sum(takewhile(
partial(operator.gt, 10),
imap(
partial(operator.mul, 2),
count()
)
)
));
assert( theSum == (0 + 0 + 2 + 4 + 6 + 8) );
Description
===========
All of the functional programming missing from :mochiref:`MochiKit.Base` lives
here. The functionality in this module is largely inspired by Python's iteration
protocol [1]_, and the itertools module [2]_.
MochiKit.Iter defines a standard way to iterate over anything, that you can
extend with :mochiref:`registerIterator`, or by implementing the ``.iter()``
protocol. Iterators are lazy, so it can potentially be cheaper to build a
filter chain of iterators than to build lots of intermediate arrays.
Especially when the data set is very large, but the result is not.
Dependencies
============
- :mochiref:`MochiKit.Base`
Overview
========
Iteration for JavaScript
------------------------
The best overview right now is in my Iteration for JavaScript [3]_ blog entry.
This information will migrate here eventually.
API Reference
=============
Errors
------
:mochidef:`StopIteration`:
The singleton :mochiref:`MochiKit.Base.NamedError` that signifies the end
of an iterator
Functions
---------
:mochidef:`applymap(fun, seq[, self])`:
``applymap(fun, seq)`` -->
fun.apply(self, seq0), fun.apply(self, seq1), ...
:mochidef:`chain(p, q[, ...])`:
``chain(p, q, ...)`` --> p0, p1, ... plast, q0, q1, ...
:mochidef:`count(n=0)`:
``count(n=0)`` --> n, n + 1, n + 2, ...
:mochidef:`cycle(p)`:
``cycle(p)`` --> p0, p1, ... plast, p0, p1, ...
:mochidef:`dropwhile(pred, seq)`:
``dropwhile(pred, seq)`` --> seq[n], seq[n + 1], starting when
pred(seq[n]) fails
:mochidef:`every(iterable, func)`:
Return ``true`` if ``func(item)`` is ``true`` for every item in
``iterable``.
:mochidef:`exhaust(iterable)`:
Exhausts an iterable without saving the results anywhere,
like :mochiref:`list(iterable)` when you don't care what the output is.
:mochidef:`forEach(iterable, func[, self])`:
Call ``func`` for each item in ``iterable``, and don't save the results.
:mochidef:`groupby(iterable[, keyfunc])`:
Make an iterator that returns consecutive keys and groups from the
iterable. The key is a function computing a key value for each element.
If not specified or is None, key defaults to an identity function and
returns the element unchanged. Generally, the iterable needs to already be
sorted on the same key function.
The returned group is itself an iterator that shares the underlying
iterable with :mochiref:`groupby()`. Because the source is shared, when the
groupby object is advanced, the previous group is no longer visible.
So, if that data is needed later, it should be stored as an array::
var groups = [];
var uniquekeys = [];
forEach(groupby(data, keyfunc), function (key_group) {
groups.push(list(key_group[1]));
uniquekeys.push(key_group[0]);
});
As a convenience, :mochiref:`groupby_as_array()` is provided to suit the above
use case.
:mochidef:`groupby_as_array(iterable[, keyfunc])`:
Perform the same task as :mochiref:`groupby()`, except return an array of
arrays instead of an iterator of iterators.
:mochidef:`iextend(lst, iterable)`:
Just like :mochiref:`list(iterable)`, except it pushes results on ``lst``
rather than creating a new one.
:mochidef:`ifilter(pred, seq)`:
``ifilter(pred, seq)`` --> elements of seq where ``pred(elem)`` is ``true``
:mochidef:`ifilterfalse(pred, seq)`:
``ifilterfalse(pred, seq)`` --> elements of seq where ``pred(elem)`` is
``false``
:mochidef:`imap(fun, p, q[, ...])`:
``imap(fun, p, q, ...)`` --> fun(p0, q0, ...), fun(p1, q1, ...), ...
:mochidef:`islice(seq, [start,] stop[, step])`:
``islice(seq, [start,] stop[, step])`` --> elements from
seq[start:stop:step] (in Python slice syntax)
:mochidef:`iter(iterable[, sentinel])`:
Convert the given argument to an iterator (object implementing
``.next()``).
1. If ``iterable`` is an iterator (implements ``.next()``), then it will
be returned as-is.
2. If ``iterable`` is an iterator factory (implements ``.iter()``), then
the result of ``iterable.iter()`` will be returned.
3. Otherwise, the iterator factory :mochiref:`MochiKit.Base.AdapterRegistry`
is used to find a match.
4. If no factory is found, it will throw ``TypeError``
Built-in iterator factories are present for Array-like objects, and
objects that implement the ``iterateNext`` protocol (e.g. the result of
Mozilla's ``document.evaluate``).
When used directly, using an iterator should look like this::
var it = iter(iterable);
try {
while (var o = it.next()) {
// use o
}
} catch (e) {
if (e != StopIteration) {
throw e;
}
// pass
}
This is ugly, so you should use the higher order functions to work
with iterators whenever possible.
:mochidef:`izip(p, q[, ...])`:
``izip(p, q, ...)`` --> [p0, q0, ...], [p1, q1, ...], ...
:mochidef:`list(iterable)`:
Convert ``iterable`` to a new ``Array``
:mochidef:`next(iterator)`:
Return ``iterator.next()``
:mochidef:`range([start,] stop[, step])`:
Return an iterator containing an arithmetic progression of integers.
``range(i, j)`` returns :mochiref:`iter([i, i + 1, i + 2, ..., j - 1])`
``start`` (!) defaults to ``0``. When ``step`` is given, it specifies the
increment (or decrement). The end point is omitted!
For example, ``range(4)`` returns :mochiref:`iter([0, 1, 2, 3])`.
This iterates over exactly the valid indexes for an array of 4 elements.
:mochidef:`reduce(fn, iterable[, initial])`:
Apply ``fn(a, b)`` cumulatively to the items of an
iterable from left to right, so as to reduce the iterable
to a single value.
For example::
reduce(function (a, b) { return x + y; }, [1, 2, 3, 4, 5])
calculates::
((((1 + 2) + 3) + 4) + 5).
If initial is given, it is placed before the items of the sequence
in the calculation, and serves as a default when the sequence is
empty.
Note that the above example could be written more clearly as::
reduce(operator.add, [1, 2, 3, 4, 5])
Or even simpler::
sum([1, 2, 3, 4, 5])
:mochidef:`registerIteratorFactory(name, check, iterfactory[, override])`:
Register an iterator factory for use with the iter function.
``check`` is a ``function(a)`` that returns ``true`` if ``a`` can be
converted into an iterator with ``iterfactory``.
``iterfactory`` is a ``function(a)`` that returns an object with a
``.next()`` method that returns the next value in the sequence.
``iterfactory`` is guaranteed to only be called if ``check(a)``
returns a true value.
If ``override`` is ``true``, then it will be made the
highest precedence iterator factory. Otherwise, the lowest.
:mochidef:`repeat(elem[, n])`:
``repeat(elem, [,n])`` --> elem, elem, elem, ... endlessly or up to n times
:mochidef:`reversed(iterable)`:
Return a reversed array from iterable.
:mochidef:`some(iterable, func)`:
Return ``true`` if ``func(item)`` is ``true`` for at least one item in
``iterable``.
:mochidef:`sorted(iterable[, cmp])`:
Return a sorted array from iterable.
:mochidef:`sum(iterable, start=0)`:
Returns the sum of a sequence of numbers plus the value
of parameter ``start`` (with a default of 0). When the sequence is
empty, returns start.
Equivalent to::
reduce(operator.add, iterable, start);
:mochidef:`takewhile(pred, seq)`:
``takewhile(pred, seq)`` --> seq[0], seq[1], ... until pred(seq[n]) fails
:mochidef:`tee(iterable, n=2)`:
``tee(it, n=2)`` --> [it1, it2, it3, ... itn] splits one iterator into n
See Also
========
.. [1] The iteration protocol is described in
PEP 234 - Iterators: http://www.python.org/peps/pep-0234.html
.. [2] Python's itertools
module: http://docs.python.org/lib/module-itertools.html
.. [3] Iteration in JavaScript: http://bob.pythonmac.org/archives/2005/07/06/iteration-in-javascript/
Authors
=======
- Bob Ippolito <bob@redivi.com>
Copyright
=========
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed
free software; you can redistribute it and/or modify it under the terms of the
`MIT License`_ or the `Academic Free License v2.1`_.
.. _`MIT License`: http://www.opensource.org/licenses/mit-license.php
.. _`Academic Free License v2.1`: http://www.opensource.org/licenses/afl-2.1.php

View File

@@ -1,284 +0,0 @@
.. title:: MochiKit.Logging - we're all tired of alert()
Name
====
MochiKit.Logging - we're all tired of alert()
Synopsis
========
::
log("INFO messages are so boring");
logDebug("DEBUG messages are even worse");
log("good thing I can pass", objects, "conveniently");
Description
===========
MochiKit.Logging steals some ideas from Python's logging module [1]_, but
completely forgot about the Java [2]_ inspiration. This is a KISS module for
logging that provides enough flexibility to do just about anything via
listeners, but without all the cruft.
Dependencies
============
- :mochiref:`MochiKit.Base`
Overview
========
Native Console Logging
----------------------
As of MochiKit 1.3, the default logger will log all messages to your browser's
native console. This is currently supported in Safari, Opera 9, and Firefox
when the FireBug__ extension is installed.
.. __: http://www.joehewitt.com/software/firebug/
To disable this behavior::
MochiKit.Logging.logger.useNativeLogging = false;
Bookmarklet Based Debugging
---------------------------
JavaScript is at a serious disadvantage without a standard console for
"print" statements. Everything else has one. The closest thing that
you get in a browser environment is the ``alert`` function, which is
absolutely evil.
This leaves you with one reasonable solution: do your logging in the page
somehow. The problem here is that you don't want to clutter the page with
debugging tools. The solution to that problem is what we call BBD, or
Bookmarklet Based Debugging [3]_.
Simply create a bookmarklet for `javascript:MochiKit.Logging.logger.debuggingBookmarklet()`__,
and whack it whenever you want to see what's in the logger. Of course, this
means you must drink the MochiKit.Logging kool-aid. It's tangy and sweet,
don't worry.
.. __: javascript:MochiKit.Logging.logger.debuggingBookmarklet()
Currently this is an ugly ``alert``, but we'll have something spiffy
Real Soon Now, and when we do, you only have to upgrade MochiKit.Logging,
not your bookmarklet!
API Reference
=============
Constructors
------------
:mochidef:`LogMessage(num, level, info)`:
Properties:
``num``:
Identifier for the log message
``level``:
Level of the log message (``"INFO"``, ``"WARN"``, ``"DEBUG"``,
etc.)
``info``:
All other arguments passed to log function as an ``Array``
``timestamp``:
``Date`` object timestamping the log message
:mochidef:`Logger([maxSize])`:
A basic logger object that has a buffer of recent messages
plus a listener dispatch mechanism for "real-time" logging
of important messages.
``maxSize`` is the maximum number of entries in the log.
If ``maxSize >= 0``, then the log will not buffer more than that
many messages. So if you don't like logging at all, be sure to
pass ``0``.
There is a default logger available named "logger", and several
of its methods are also global functions:
``logger.log`` -> ``log``
``logger.debug`` -> ``logDebug``
``logger.warning`` -> ``logWarning``
``logger.error`` -> ``logError``
``logger.fatal`` -> ``logFatal``
:mochidef:`Logger.prototype.addListener(ident, filter, listener)`:
Add a listener for log messages.
``ident`` is a unique identifier that may be used to remove the listener
later on.
``filter`` can be one of the following:
``null``:
``listener(msg)`` will be called for every log message
received.
``string``:
:mochiref:`logLevelAtLeast(filter)` will be used as the function
(see below).
``function``:
``filter(msg)`` will be called for every msg, if it returns
true then ``listener(msg)`` will be called.
``listener`` is a function that takes one argument, a log message. A log
message is an object (:mochiref:`LogMessage` instance) that has at least these
properties:
``num``:
A counter that uniquely identifies a log message (per-logger)
``level``:
A string or number representing the log level. If string, you
may want to use ``LogLevel[level]`` for comparison.
``info``:
An Array of objects passed as additional arguments to the ``log``
function.
:mochidef:`Logger.prototype.baseLog(level, message[, ...])`:
The base functionality behind all of the log functions.
The first argument is the log level as a string or number,
and all other arguments are used as the info list.
This function is available partially applied as:
============== =========
Logger.debug 'DEBUG'
Logger.log 'INFO'
Logger.error 'ERROR'
Logger.fatal 'FATAL'
Logger.warning 'WARNING'
============== =========
For the default logger, these are also available as global functions,
see the :mochiref:`Logger` constructor documentation for more info.
:mochidef:`Logger.prototype.clear()`:
Clear all messages from the message buffer.
:mochidef:`Logger.prototype.debuggingBookmarklet()`:
Display the contents of the logger in a useful way for browsers.
Currently, if :mochiref:`MochiKit.LoggingPane` is loaded, then a pop-up
:mochiref:`MochiKit.LoggingPane.LoggingPane` will be used. Otherwise,
it will be an alert with :mochiref:`Logger.prototype.getMessageText()`.
:mochidef:`Logger.prototype.dispatchListeners(msg)`:
Dispatch a log message to all listeners.
:mochidef:`Logger.prototype.getMessages(howMany)`:
Return a list of up to ``howMany`` messages from the message buffer.
:mochidef:`Logger.prototype.getMessageText(howMany)`:
Get a string representing up to the last ``howMany`` messages in the
message buffer. The default is ``30``.
The message looks like this::
LAST {messages.length} MESSAGES:
[{msg.num}] {msg.level}: {m.info.join(' ')}
[{msg.num}] {msg.level}: {m.info.join(' ')}
...
If you want some other format, use
:mochiref:`Logger.prototype.getMessages` and do it yourself.
:mochidef:`Logger.prototype.removeListener(ident)`:
Remove a listener using the ident given to :mochiref:`Logger.prototype.addListener`
Functions
---------
:mochidef:`alertListener(msg)`:
Ultra-obnoxious ``alert(...)`` listener
:mochidef:`logDebug(message[, info[, ...]])`:
Log an INFO message to the default logger
:mochidef:`logDebug(message[, info[, ...]])`:
Log a DEBUG message to the default logger
:mochidef:`logError(message[, info[, ...]])`:
Log an ERROR message to the default logger
:mochidef:`logFatal(message[, info[, ...]])`:
Log a FATAL message to the default logger
:mochidef:`logLevelAtLeast(minLevel)`:
Return a function that will match log messages whose level
is at least minLevel
:mochidef:`logWarning(message[, info[, ...]])`:
Log a WARNING message to the default logger
See Also
========
.. [1] Python's logging module: http://docs.python.org/lib/module-logging.html
.. [2] PEP 282, where they admit all of the Java influence: http://www.python.org/peps/pep-0282.html
.. [3] Original Bookmarklet Based Debugging blather: http://bob.pythonmac.org/archives/2005/07/03/bookmarklet-based-debugging/
Authors
=======
- Bob Ippolito <bob@redivi.com>
Copyright
=========
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed
free software; you can redistribute it and/or modify it under the terms of the
`MIT License`_ or the `Academic Free License v2.1`_.
.. _`MIT License`: http://www.opensource.org/licenses/mit-license.php
.. _`Academic Free License v2.1`: http://www.opensource.org/licenses/afl-2.1.php

View File

@@ -1,114 +0,0 @@
.. title:: MochiKit.LoggingPane - Interactive MochiKit.Logging pane
Name
====
MochiKit.LoggingPane - Interactive MochiKit.Logging pane
Synopsis
========
::
// open a pop-up window
createLoggingPane()
// use a div at the bottom of the document
createLoggingPane(true);
Description
===========
MochiKit.Logging does not have any browser dependencies and is completely
unobtrusive. MochiKit.LoggingPane is a browser-based colored viewing pane
for your :mochiref:`MochiKit.Logging` output that can be used as a pop-up or
inline.
It also allows for regex and level filtering! MochiKit.LoggingPane is used
as the default :mochiref:`MochiKit.Logging.debuggingBookmarklet()` if it is
loaded.
Dependencies
============
- :mochiref:`MochiKit.Base`
- :mochiref:`MochiKit.Logging`
API Reference
=============
Constructors
------------
:mochidef:`LoggingPane(inline=false, logger=MochiKit.Logging.logger)`:
A listener for a :mochiref:`MochiKit.Logging` logger with an interactive
DOM representation.
If ``inline`` is ``true``, then the ``LoggingPane`` will be a ``DIV``
at the bottom of the document. Otherwise, it will be in a pop-up
window with a name based on the calling page's URL. If there is an
element in the document with an id of ``_MochiKit_LoggingPane``,
it will be used instead of appending a new ``DIV`` to the body.
``logger`` is the reference to the :mochiref:`MochiKit.Logging.Logger` to
listen to. If not specified, the global default logger is used.
Properties:
``win``:
Reference to the pop-up window (``undefined`` if ``inline``)
``inline``:
``true`` if the ``LoggingPane`` is inline
``colorTable``:
An object with property->value mappings for each log level
and its color. May also be mutated on ``LoggingPane.prototype``
to affect all instances. For example::
MochiKit.LoggingPane.LoggingPane.prototype.colorTable = {
DEBUG: "green",
INFO: "black",
WARNING: "blue",
ERROR: "red",
FATAL: "darkred"
};
:mochidef:`LoggingPane.prototype.closePane()`:
Close the :mochiref:`LoggingPane` (close the child window, or
remove the ``_MochiKit_LoggingPane`` ``DIV`` from the document).
Functions
---------
:mochidef:`createLoggingPane(inline=false)`:
Create or return an existing :mochiref:`LoggingPane` for this document
with the given inline setting. This is preferred over using
:mochiref:`LoggingPane` directly, as only one :mochiref:`LoggingPane`
should be present in a given document.
Authors
=======
- Bob Ippolito <bob@redivi.com>
Copyright
=========
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed
free software; you can redistribute it and/or modify it under the terms of the
`MIT License`_ or the `Academic Free License v2.1`_.
.. _`MIT License`: http://www.opensource.org/licenses/mit-license.php
.. _`Academic Free License v2.1`: http://www.opensource.org/licenses/afl-2.1.php

View File

@@ -1,349 +0,0 @@
.. title:: MochiKit.Signal - Simple universal event handling
.. |---| unicode:: U+2014 .. em dash, trimming surrounding whitespace
:trim:
Name
====
MochiKit.Signal - Simple universal event handling
Synopsis
========
Signal for DOM events::
// DOM events are also signals. Connect freely! The functions will be
// called with the custom event as a parameter.
// calls myClicked.apply(getElement('myID'), event)
connect('myID', 'onclick', myClicked);
// calls wasClicked.apply(myObject, event)
connect('myID', 'onclick', myObject, wasClicked);
// calls myObject.wasClicked(event)
connect('myID', 'onclick', myObject, 'wasClicked');
// the event is normalized, no more e = e || window.event!
myObject.wasClicked = function(e) {
var crossBrowserCoordinates = e.mouse().page;
// e.mouse().page is a MochiKit.DOM.Coordinates object
}
Signal for non-DOM events::
// otherObject.gotFlash() will be called when 'flash' signalled.
connect(myObject, 'flash', otherObject, 'gotFlash');
// gotBang.apply(otherObject) will be called when 'bang' signalled.
// You can access otherObject from within gotBang as 'this'.
connect(myObject, 'bang', otherObject, gotBang);
// myFunc.apply(myObject) will be called when 'flash' signalled.
// You can access myObject from within myFunc as 'this'.
var ident = connect(myObject, 'flash', myFunc);
// You may disconnect with the return value from connect
disconnect(ident);
// Signal can take parameters. These will be passed along to the connected
// functions.
signal(myObject, 'flash');
signal(myObject, 'bang', 'BANG!');
Description
===========
Event handling was never so easy!
This module takes care of all the hard work |---| figuring out which event
model to use, trying to retrieve the event object, and handling your own
internal events, as well as cleanup when the page is unloaded to clean up IE's
nasty memory leakage.
This event system is largely based on Qt's signal/slot system. Read more on
how that is handled and also how it is used in model/view programming at:
http://doc.trolltech.com/
Dependencies
============
- :mochiref:`MochiKit.Base`
- :mochiref:`MochiKit.DOM`
Overview
========
Using Signal for DOM Events
---------------------------
When using MochiKit.Signal, do not use the browser's native event API. That
means, no ``onclick="blah"``, no ``elem.addEventListener(...)``, and certainly
no ``elem.attachEvent(...)``. This also means that
:mochiref:`MochiKit.DOM.addToCallStack` and
:mochiref:`MochiKit.DOM.addLoadEvent` should not be used in combination with
this module.
Signals for DOM objects are named with the ``'on'`` prefix, e.g.:
``'onclick'``, ``'onkeyup'``, etc.
When the signal fires, your slot will be called with one parameter, the custom
event object.
Custom Event Objects for DOM events
-----------------------------------
Signals triggered by DOM events are called with a custom event object as a
parameter. The custom event object presents a consistent view of the event
across all supported platforms and browsers, and provides many conveniences
not available even in a correct W3C implementation.
See the `DOM Custom Event Object Reference`_ for a detailed API description
of this object.
If you find that you're accessing the native event for any reason, create a
`new ticket`_ and we'll look into normalizing the behavior you're looking for.
.. _`new ticket`: http://trac.mochikit.com/newticket
.. _`Safari bug 6595`: http://bugzilla.opendarwin.org/show_bug.cgi?id=6595
.. _`Safari bug 7790`: http://bugzilla.opendarwin.org/show_bug.cgi?id=7790
Memory Usage
------------
Any object that has connected slots (via :mochiref:`connect()`) is referenced
by the Signal mechanism until it is disconnected via :mochiref:`disconnect()`
or :mochiref:`disconnectAll()`.
Signal does not leak. It registers an ``'onunload'`` event that disconnects all
objects on the page when the browser leaves the page. However, memory usage
will grow during the page view for every connection made until it is
disconnected. Even if the DOM object is removed from the document, it
will still be referenced by Signal until it is explicitly disconnected.
In order to conserve memory during the page view, :mochiref:`disconnectAll()`
any DOM elements that are about to be removed from the document.
Using Signal for non-DOM objects
--------------------------------
Signals are triggered with the :mochiref:`signal(src, 'signal', ...)`
function. Additional parameters passed to this are passed onto the
connected slots. Explicit signals are not required for DOM events.
Slots that are connected to a signal are called in the following manner
when that signal is signalled:
- If the slot was a single function, then it is called with ``this`` set
to the object originating the signal with whatever parameters it was
signalled with.
- If the slot was an object and a function, then it is called with
``this`` set to the object, and with whatever parameters it was
signalled with.
- If the slot was an object and a string, then ``object[string]`` is
called with the parameters to the signal.
API Reference
=============
Signal API Reference
--------------------
:mochidef:`connect(src, signal, dest[, func])`:
Connects a signal to a slot, and return a unique identifier that can be
used to disconnect that signal.
``src`` is the object that has the signal. You may pass in a string, in
which case, it is interpreted as an id for an HTML element.
``signal`` is a string that represents a signal name. If 'src' is an HTML
Element, ``window``, or the ``document``, then it can be one of the
'on-XYZ' events. You must include the 'on' prefix, and it must be all
lower-case.
``dest`` and ``func`` describe the slot, or the action to take when the
signal is triggered.
- If ``dest`` is an object and ``func`` is a string, then
``dest[func].apply(dest, ...)`` will be called when the signal
is signalled.
- If ``dest`` is an object and ``func`` is a function, then
``func.apply(dest, ...)`` will be called when the signal is
signalled.
- If ``func`` is undefined and ``dest`` is a function, then
``func.apply(src, ...)`` will be called when the signal is
signalled.
No other combinations are allowed and will raise an exception.
The return value can be passed to :mochiref:`disconnect` to disconnect
the signal.
:mochidef:`disconnect(ident)`:
To disconnect a signal, pass its ident returned by :mochiref:`connect()`.
This is similar to how the browser's ``setTimeout`` and ``clearTimeout``
works.
:mochidef:`disconnectAll(src[, signal, ...])`:
``disconnectAll(src)`` removes all signals from src.
``disconnectAll(src, 'onmousedown', 'mySignal')`` will remove all
``'onmousedown'`` and ``'mySignal'`` signals from src.
:mochidef:`signal(src, signal, ...)`:
This will signal a signal, passing whatever additional parameters on to
the connected slots. ``src`` and ``signal`` are the same as for
:mochiref:`connect()`.
DOM Custom Event Object Reference
---------------------------------
:mochidef:`event()`:
The native event produced by the browser. You should not need to use this.
:mochidef:`src()`:
The element that this signal is connected to.
:mochidef:`type()`:
The event type (``'click'``, ``'mouseover'``, ``'keypress'``, etc.) as a
string. Does not include the ``'on'`` prefix.
:mochidef:`target()`:
The element that triggered the event. This may be a child of
:mochiref:`src()`.
:mochidef:`modifier()`:
Returns ``{shift, ctrl, meta, alt, any}``, where each property is ``true``
if its respective modifier key was pressed, ``false`` otherwise. ``any``
is ``true`` if any modifier is pressed, ``false`` otherwise.
:mochidef:`stopPropagation()`:
Works like W3C's ``stopPropagation()``.
:mochidef:`preventDefault()`:
Works like W3C's ``preventDefault()``.
:mochidef:`stop()`:
Shortcut that calls ``stopPropagation()`` and ``preventDefault()``.
:mochidef:`key()`:
Returns ``{code, string}``.
Use ``'onkeydown'`` and ``'onkeyup'`` handlers to detect control
characters such as ``'KEY_F1'``. Use the ``'onkeypressed'`` handler to
detect "printable" characters, such as ``'é'``.
When a user presses F1, in ``'onkeydown'`` and ``'onkeyup'`` this method
returns ``{code: 122, string: 'KEY_F1'}``. In ``'onkeypress'``, it returns
``{code: 0, string: ''}``.
If a user presses Shift+2 on a US keyboard, this method returns
``{code: 50, string: 'KEY_2'}`` in ``'onkeydown'`` and ``'onkeyup'``.
In ``'onkeypress'``, it returns ``{code: 64, string: '@'}``.
See ``_specialKeys`` in the source code for a comprehensive list of
control characters.
:mochidef:`mouse()`:
Properties for ``'onmouse*'``, ``'onclick'``, ``'ondblclick'``, and
``'oncontextmenu'``:
- ``page`` is a :mochiref:`MochiKit.DOM.Coordinates` object that
represents the cursor position relative to the HTML document.
Equivalent to ``pageX`` and ``pageY`` in Safari, Mozilla, and
Opera.
- ``client`` is a :mochiref:`MochiKit.DOM.Coordinates` object that
represents the cursor position relative to the visible portion of
the HTML document. Equivalent to ``clientX`` and ``clientY`` on
all browsers.
Properties for ``'onmouseup'``, ``'onmousedown'``, ``'onclick'``, and
``'ondblclick'``:
- ``mouse().button`` returns ``{left, right, middle}`` where each
property is ``true`` if the mouse button was pressed, ``false``
otherwise.
Known browser bugs:
- Current versions of Safari won't signal ``'ondblclick'`` when
attached via ``connect()`` (`Safari Bug 7790`_).
- Mac browsers don't report right-click consistently. Firefox
signals the slot and sets ``modifier().ctrl`` to true, Opera
signals the slot and sets ``modifier().meta`` to ``true``, and
Safari doesn't signal the slot at all (`Safari Bug 6595`_).
To find a right-click in Safari, Firefox, and IE, you can connect
an element to ``'oncontextmenu'``. This doesn't work in Opera.
:mochidef:`relatedTarget()`:
Returns the document element that the mouse has moved to. This is
generated for ``'onmouseover'`` and ``'onmouseout'`` events.
Authors
=======
- Jonathan Gardner <jgardner@jonathangardner.net>
- Beau Hartshorne <beau@hartshornesoftware.com>
- Bob Ippolito <bob@redivi.com>
Copyright
=========
Copyright 2006 Jonathan Gardner <jgardner@jonathangardner.net>, Beau
Hartshorne <beau@hartshornesoftware.com>, and Bob Ippolito <bob@redivi.com>.
This program is dual-licensed free software; you can redistribute it and/or
modify it under the terms of the `MIT License`_ or the
`Academic Free License v2.1`_.
.. _`MIT License`: http://www.opensource.org/licenses/mit-license.php
.. _`Academic Free License v2.1`: http://www.opensource.org/licenses/afl-2.1.php

View File

@@ -1,244 +0,0 @@
2006-04-29 v1.3.1 (bug fix release)
- Fix sendXMLHttpRequest sendContent regression
- Internet Explorer fix in MochiKit.Logging (printfire exception)
- Internet Explorer XMLHttpRequest object leak fixed in MochiKit.Async
2006-04-26 v1.3 "warp zone"
- IMPORTANT: Renamed MochiKit.Base.forward to forwardCall (for export)
- IMPORTANT: Renamed MochiKit.Base.find to findValue (for export)
- New MochiKit.Base.method as a convenience form of bind that takes the
object before the method
- New MochiKit.Base.flattenArguments for flattening a list of arguments to
a single Array
- Refactored MochiRegExp example to use MochiKit.Signal
- New key_events example demonstrating use of MochiKit.Signal's key handling
capabilities.
- MochiKit.DOM.createDOM API change for convenience: if attrs is a string,
null is used and the string will be considered the first node. This
allows for the more natural P("foo") rather than P(null, "foo").
- MochiKit Interpreter example refactored to use MochiKit.Signal and now
provides multi-line input and a help() function to get MochiKit function
signature from the documentation.
- Native Console Logging for the default MochiKit.Logging logger
- New MochiKit.Async.DeferredList, gatherResults, maybeDeferred
- New MochiKit.Signal example: draggable
- Added sanity checking to Deferred to ensure that errors happen when chaining
is used incorrectly
- Opera sendXMLHttpRequest fix (sends empty string instead of null by default)
- Fix a bug in MochiKit.Color that incorrectly generated hex colors for
component values smaller than 16/255.
- Fix a bug in MochiKit.Logging that prevented logs from being capped at a
maximum size
- MochiKit.Async.Deferred will now wrap thrown objects that are not instanceof
Error, so that the errback chain is used instead of the callback chain.
- MochiKit.DOM.appendChildNodes and associated functions now append iterables
in the correct order.
- New MochiKit-based SimpleTest test runner as a replacement for Test.Simple
- MochiKit.Base.isNull no longer matches undefined
- example doctypes changed to HTML4
- isDateLike no longer throws error on null
- New MochiKit.Signal module, modeled after the slot/signal mechanism in Qt
- updated elementDimensions to calculate width from offsetWidth instead
of clientWidth
- formContents now works with FORM tags that have a name attribute
- Documentation now uses MochiKit to generate a function index
2006-01-26 v1.2 "the ocho"
- Fixed MochiKit.Color.Color.lighterColorWithLevel
- Added new MochiKit.Base.findIdentical function to find the index of an
element in an Array-like object. Uses === for identity comparison.
- Added new MochiKit.Base.find function to find the index of an element in
an Array-like object. Uses compare for rich comparison.
- MochiKit.Base.bind will accept a string for func, which will be immediately
looked up as self[func].
- MochiKit.DOM.formContents no longer skips empty form elements for Zope
compatibility
- MochiKit.Iter.forEach will now catch StopIteration to break
- New MochiKit.DOM.elementDimensions(element) for determining the width and
height of an element in the document
- MochiKit.DOM's initialization is now compatible with
HTMLUnit + JWebUnit + Rhino
- MochiKit.LoggingPane will now re-use a ``_MochiKit_LoggingPane`` DIV element
currently in the document instead of always creating one.
- MochiKit.Base now has operator.mul
- MochiKit.DOM.formContents correctly handles unchecked checkboxes that have
a custom value attribute
- Added new MochiKit.Color constructors fromComputedStyle and fromText
- MochiKit.DOM.setNodeAttribute should work now
- MochiKit.DOM now has a workaround for an IE bug when setting the style
property to a string
- MochiKit.DOM.createDOM now has workarounds for IE bugs when setting the
name and for properties
- MochiKit.DOM.scrapeText now walks the DOM tree in-order
- MochiKit.LoggingPane now sanitizes the window name to work around IE bug
- MochiKit.DOM now translates usemap to useMap to work around IE bug
- MochiKit.Logging is now resistant to Prototype's dumb Object.prototype hacks
- Added new MochiKit.DOM documentation on element visibility
- New MochiKit.DOM.elementPosition(element[, relativeTo={x: 0, y: 0}])
for determining the position of an element in the document
- Added new MochiKit.DOM createDOMFunc aliases: CANVAS, STRONG
2005-11-14 v1.1
- Fixed a bug in numberFormatter with large numbers
- Massively overhauled documentation
- Fast-path for primitives in MochiKit.Base.compare
- New groupby and groupby_as_array in MochiKit.Iter
- Added iterator factory adapter for objects that implement iterateNext()
- Fixed isoTimestamp to handle timestamps with time zone correctly
- Added new MochiKit.DOM createDOMFunc aliases: SELECT, OPTION, OPTGROUP,
LEGEND, FIELDSET
- New MochiKit.DOM formContents and enhancement to queryString to support it
- Updated view_source example to use dp.SyntaxHighlighter 1.3.0
- MochiKit.LoggingPane now uses named windows based on the URL so that
a given URL will get the same LoggingPane window after a reload
(at the same position, etc.)
- MochiKit.DOM now has currentWindow() and currentDocument() context
variables that are set with withWindow() and withDocument(). These
context variables affect all MochiKit.DOM functionality (getElement,
createDOM, etc.)
- MochiKit.Base.items will now catch and ignore exceptions for properties
that are enumerable but not accessible (e.g. permission denied)
- MochiKit.Async.Deferred's addCallback/addErrback/addBoth
now accept additional arguments that are used to create a partially
applied function. This differs from Twisted in that the callback/errback
result becomes the *last* argument, not the first when this feature
is used.
- MochiKit.Async's doSimpleXMLHttpRequest will now accept additional
arguments which are used to create a GET query string
- Did some refactoring to reduce the footprint of MochiKit by a few
kilobytes
- escapeHTML to longer escapes ' (apos) and now uses
String.replace instead of iterating over every char.
- Added DeferredLock to Async
- Renamed getElementsComputedStyle to computedStyle and moved
it from MochiKit.Visual to MochiKit.DOM
- Moved all color support out of MochiKit.Visual and into MochiKit.Color
- Fixed range() to accept a negative step
- New alias to MochiKit.swapDOM called removeElement
- New MochiKit.DOM.setNodeAttribute(node, attr, value) which sets
an attribute on a node without raising, roughly equivalent to:
updateNodeAttributes(node, {attr: value})
- New MochiKit.DOM.getNodeAttribute(node, attr) which gets the value of
a node's attribute or returns null without raising
- Fixed a potential IE memory leak if using MochiKit.DOM.addToCallStack
directly (addLoadEvent did not leak, since it clears the handler)
2005-10-24 v1.0
- New interpreter example that shows usage of MochiKit.DOM to make
an interactive JavaScript interpreter
- New MochiKit.LoggingPane for use with the MochiKit.Logging
debuggingBookmarklet, with logging_pane example to show its usage
- New mochiregexp example that demonstrates MochiKit.DOM and MochiKit.Async
in order to provide a live regular expression matching tool
- Added advanced number formatting capabilities to MochiKit.Format:
numberFormatter(pattern, placeholder="", locale="default") and
formatLocale(locale="default")
- Added updatetree(self, obj[, ...]) to MochiKit.Base, and changed
MochiKit.DOM's updateNodeAttributes(node, attrs) to use it when appropiate.
- Added new MochiKit.DOM createDOMFunc aliases: BUTTON, TT, PRE
- Added truncToFixed(aNumber, precision) and roundToFixed(aNumber, precision)
to MochiKit.Format
- MochiKit.DateTime can now handle full ISO 8601 timestamps, specifically
isoTimestamp(isoString) will convert them to Date objects, and
toISOTimestamp(date, true) will return an ISO 8601 timestamp in UTC
- Fixed missing errback for sendXMLHttpRequest when the server does not
respond
- Fixed infinite recusion bug when using roundClass("DIV", ...)
- Fixed a bug in MochiKit.Async wait (and callLater) that prevented them
from being cancelled properly
- Workaround in MochiKit.Base bind (and partial) for functions that don't
have an apply method, such as alert
- Reliably return null from the string parsing/manipulation functions if
the input can't be coerced to a string (s + "") or the input makes no sense;
e.g. isoTimestamp(null) and isoTimestamp("") return null
2005-10-08 v0.90
- Fixed ISO compliance with toISODate
- Added missing operator.sub
- Placated Mozilla's strict warnings a bit
- Added JSON serialization and unserialization support to MochiKit.Base:
serializeJSON, evalJSON, registerJSON. This is very similar to the repr
API.
- Fixed a bug in the script loader that failed in some scenarios when a script
tag did not have a "src" attribute (thanks Ian!)
- Added new MochiKit.DOM createDOMFunc aliases: H1, H2, H3, BR, HR, TEXTAREA,
P, FORM
- Use encodeURIComponent / decodeURIComponent for MochiKit.Base urlEncode
and parseQueryString, when available.
2005-08-12 v0.80
- Source highlighting in all examples, moved to a view-source example
- Added some experimental syntax highlighting for the Rounded Corners example,
via the LGPL dp.SyntaxHighlighter 1.2.0 now included in examples/common/lib
- Use an indirect binding for the logger conveniences, so that the global
logger could be replaced by setting MochiKit.Logger.logger to something else
(though an observer is probably a better choice).
- Allow MochiKit.DOM.getElementsByTagAndClassName to take a string for parent,
which will be looked up with getElement
- Fixed bug in MochiKit.Color.fromBackground (was using node.parent instead of
node.parentNode)
- Consider a 304 (NOT_MODIFIED) response from XMLHttpRequest to be success
- Disabled Mozilla map(...) fast-path due to Deer Park compatibility issues
- Possible workaround for Safari issue with swapDOM, where it would get
confused because two elements were in the DOM at the same time with the
same id
- Added missing THEAD convenience function to MochiKit.DOM
- Added lstrip, rstrip, strip to MochiKit.Format
- Added updateNodeAttributes, appendChildNodes, replaceChildNodes to
MochiKit.DOM
- MochiKit.Iter.iextend now has a fast-path for array-like objects
- Added HSV color space support to MochiKit.Visual
- Fixed a bug in the sortable_tables example, it now converts types
correctly
- Fixed a bug where MochiKit.DOM referenced MochiKit.Iter.next from global
scope
2005-08-04 v0.70
- New ajax_tables example, which shows off XMLHttpRequest, ajax, json, and
a little TAL-ish DOM templating attribute language.
- sendXMLHttpRequest and functions that use it (loadJSONDoc, etc.) no longer
ignore requests with status == 0, which seems to happen for cached or local
requests
- Added sendXMLHttpRequest to MochiKit.Async.EXPORT, d'oh.
- Changed scrapeText API to return a string by default. This is API-breaking!
It was dumb to have the default return value be the form you almost never
want. Sorry.
- Added special form to swapDOM(dest, src). If src is null, dest is removed
(where previously you'd likely get a DOM exception).
- Added three new functions to MochiKit.Base for dealing with URL query
strings: urlEncode, queryString, parseQueryString
- MochiKit.DOM.createDOM will now use attr[k] = v for all browsers if the name
starts with "on" (e.g. "onclick"). If v is a string, it will set it to
new Function(v).
- Another workaround for Internet "worst browser ever" Explorer's setAttribute
usage in MochiKit.DOM.createDOM (checked -> defaultChecked).
- Added UL, OL, LI convenience createDOM aliases to MochiKit.DOM
- Packing is now done by Dojo's custom Rhino interpreter, so it's much smaller
now!
2005-07-29 v0.60
- Beefed up the MochiKit.DOM test suite
- Fixed return value for MochiKit.DOM.swapElementClass, could return
false unexpectedly before
- Added an optional "parent" argument to
MochiKit.DOM.getElementsByTagAndClassName
- Added a "packed" version in packed/MochiKit/MochiKit.js
- Changed build script to rewrite the URLs in tests to account for the
JSAN-required reorganization
- MochiKit.Compat to potentially work around IE 5.5 issues
(5.0 still not supported). Test.Simple doesn't seem to work there,
though.
- Several minor documentation corrections
2005-07-27 v0.50
- Initial Release

View File

@@ -1,127 +0,0 @@
.. title:: MochiKit.Visual - visual effects
Name
====
MochiKit.Visual - visual effects
Synopsis
========
::
// round the corners of all h1 elements
roundClass("h1", null);
// round the top left corner of the element with the id "title"
roundElement("title", {corners: "tl"});
Description
===========
MochiKit.Visual provides visual effects and support functions for visuals.
Dependencies
============
- :mochiref:`MochiKit.Base`
- :mochiref:`MochiKit.Iter`
- :mochiref:`MochiKit.DOM`
- :mochiref:`MochiKit.Color`
Overview
========
At this time, MochiKit.Visual provides one visual effect: rounded corners
for your HTML elements. These rounded corners are created completely
through CSS manipulations and require no external images or style sheets.
This implementation was adapted from Rico_.
.. _Rico: http://www.openrico.org
API Reference
=============
Functions
---------
:mochidef:`roundClass(tagName[, className[, options]])`:
Rounds all of the elements that match the ``tagName`` and ``className``
specifiers, using the options provided. ``tagName`` or ``className`` can
be ``null`` to match all tags or classes. For more information about
the options, see the :mochiref:`roundElement` function.
:mochidef:`roundElement(element[, options])`:
Immediately round the corners of the specified element.
The element can be given as either a string
with the element ID, or as an element object.
The options mapping has the following defaults:
========= =================
corners ``"all"``
color ``"fromElement"``
bgColor ``"fromParent"``
blend ``true``
border ``false``
compact ``false``
========= =================
corners:
specifies which corners of the element should be rounded.
Choices are:
- all
- top
- bottom
- tl (top left)
- bl (bottom left)
- tr (top right)
- br (bottom right)
Example:
``"tl br"``: top-left and bottom-right corners are rounded
blend:
specifies whether the color and background color should be blended
together to produce the border color.
See Also
========
.. [1] Application Kit Reference - NSColor: http://developer.apple.com/documentation/Cocoa/Reference/ApplicationKit/ObjC_classic/Classes/NSColor.html
.. [2] SVG 1.0 color keywords: http://www.w3.org/TR/SVG/types.html#ColorKeywords
.. [3] W3C CSS3 Color Module: http://www.w3.org/TR/css3-color/#svg-color
Authors
=======
- Kevin Dangoor <dangoor@gmail.com>
- Bob Ippolito <bob@redivi.com>
- Originally adapted from Rico <http://openrico.org/> (though little remains)
Copyright
=========
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed
free software; you can redistribute it and/or modify it under the terms of the
`MIT License`_ or the `Academic Free License v2.1`_.
.. _`MIT License`: http://www.opensource.org/licenses/mit-license.php
.. _`Academic Free License v2.1`: http://www.opensource.org/licenses/afl-2.1.php
Portions adapted from `Rico`_ are available under the terms of the
`Apache License, Version 2.0`_.
.. _`Apache License, Version 2.0`: http://www.apache.org/licenses/LICENSE-2.0.html

View File

@@ -1,74 +0,0 @@
.. title:: MochiKit Documentation Index
Distribution
============
MochiKit - makes JavaScript suck a bit less
- :mochiref:`MochiKit.Async` - manage asynchronous tasks
- :mochiref:`MochiKit.Base` - functional programming and useful comparisons
- :mochiref:`MochiKit.DOM` - painless DOM manipulation API
- :mochiref:`MochiKit.Color` - color abstraction with CSS3 support
- :mochiref:`MochiKit.DateTime` - "what time is it anyway?"
- :mochiref:`MochiKit.Format` - string formatting goes here
- :mochiref:`MochiKit.Iter` - itertools for JavaScript; iteration made HARD,
and then easy
- :mochiref:`MochiKit.Logging` - we're all tired of ``alert()``
- :mochiref:`MochiKit.LoggingPane` - interactive :mochiref:`MochiKit.Logging`
pane
- :mochiref:`MochiKit.Signal` - simple universal event handling
- :mochiref:`MochiKit.Visual` - visual effects
Notes
=====
To turn on MochiKit's compatibility mode, do this before loading MochiKit::
<script type="text/javascript">MochiKit = {__compat__: true};</script>
When compatibility mode is on, you must use fully qualified names for all
MochiKit functions (e.g. ``MochiKit.Base.map(...)``).
Screencasts
===========
- `MochiKit 1.1 Intro`__
.. __: http://mochikit.com/screencasts/MochiKit_Intro-1
See Also
========
.. _`mochikit.com`: http://mochikit.com/
.. _`from __future__ import *`: http://bob.pythonmac.org/
.. _`MochiKit on JSAN`: http://openjsan.org/doc/b/bo/bob/MochiKit/
.. _`MochiKit tag on del.icio.us`: http://del.icio.us/tag/mochikit
.. _`MochiKit tag on Technorati`: http://technorati.com/tag/mochikit
.. _`Google Groups: MochiKit`: http://groups.google.com/group/mochikit
- `Google Groups: MochiKit`_: The official mailing list for discussions
related to development of and with MochiKit
- `mochikit.com`_: MochiKit's home on the web
- `from __future__ import *`_: Bob Ippolito's blog
- `MochiKit on JSAN`_: the JSAN distribution page for MochiKit
- `MochiKit tag on del.icio.us`_: Recent bookmarks related to MochiKit
- `MochiKit tag on Technorati`_: Recent blog entries related to MochiKit
Version History
===============
.. include:: VersionHistory.rst
Copyright
=========
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed
free software; you can redistribute it and/or modify it under the terms of the
`MIT License`_ or the `Academic Free License v2.1`_.
.. _`MIT License`: http://www.opensource.org/licenses/mit-license.php
.. _`Academic Free License v2.1`: http://www.opensource.org/licenses/afl-2.1.php

View File

@@ -1,69 +0,0 @@
h1 {
font-size: 2em;
color: #4B4545;
text-align: center;
}
table.datagrid {
width: 100%;
border-collapse: collapse;
}
table.datagrid thead th {
text-align: left;
background-color: #4B4545;
background-repeat: no-repeat;
background-position: right center;
color: white;
font-weight: bold;
padding: .3em .7em;
font-size: .9em;
padding-right: 5px;
background-repeat: no-repeat;
background-position: 95% right;
}
table.datagrid thead th a {
color: white;
text-decoration: none;
font-size: 1.0em;
background-repeat: no-repeat;
background-position: center right;
padding-right: 15px;
}
table.datagrid thead th.over {
background-color: #746B6B;
cursor: pointer;
}
table.datagrid tbody th {
font-weight: bold;
}
table.datagrid tbody td, table.datagrid tbody th {
text-align: left;
padding: .3em .7em;
border-bottom: 1px solid #eee;
}
table.datagrid tbody tr.alternate td, table.datagrid tbody tr.alternate th {
background-color: #f1f1f1;
}
table.datagrid tfoot td, table.datagrid tfoot th {
background-color: #FFFEE3;
color: #4B4545;
padding: .5em;
font-weight: bold;
border-top: 2px solid #4B4545;
}
table.datagrid tfoot th { text-align: left; }
table.datagrid tfoot td { }
.invisible { display: none; }
.mochi-template { display: none; }
.mochi-example { display: none; }

Some files were not shown because too many files have changed in this diff Show More