Question

The browser-based software StudyTRAX ( http://wiki.studytrax.com ), used for research data management, allows for custom form and form variable management via JavaScript. However, a StudyTRAX “variable” (essentially, a representation of both an element of a form [HTML properties included] and its corresponding parameter, with some data typing/etc.) must be referred to with #<varname>, while regular JavaScript variables will just be <varname>.

Is this sort of thing done to make parsing easier, or is it just to distinguish between the two so that researchers who aren’t so technologically-inclined won’t have as much trouble figuring out what they’re doing? Given the nature of JavaScript, I would think the StudyTRAX “variables” are just regular JavaScript objects defined in such a way to make form design and customization simpler, and thus the latter would make more sense, but am I wrong?

Also, I know that there are other programming languages that do require specific variable prefixes (though I can’t think of some off the top of my head at the moment); what is/was the usual reasoning for that choice in language design?

Answer 1

Two part answer, StudyTRAX is almost certainly using a preprocessor to do some magic. JavaScript makes this relativity easy, but not as easy as a Lisp would. You still need to parse the code. By prefixing, the parser can ignore a lot of the complicated syntax of JavaScript and get to the good part without needing a “picture perfect” compiler. Actually, a lot of templeting systems do this. It is an implementation of Lisp’s quasi-quote (see Greenspun’s Tenth Rule).

As for prefixes in general, the best way to understand them is to try to write a parser for a language without them. For very dynamic and pure languages like Lisp and JavaScript where everything is a List / object it is not too bad. When you get languages where methods are distinct from objects, or functions are not first class the parser begins having to ask itself what type of thing doe “foo” refer to? An annoying example from Ruby: an unprefixed identifier is either a local variable or a method implicitly on self. In Rails there are a few functions that are implemented with method_missing. Person.find_first_by_rank works fine, but

Class Person < ActiveRecord::Base
  def promotion(name)
    p = find_first_by_rank
    [...]
  end
end

gives an error because find_first_by_rank looks like it might be a local variable and Ruby is scared to call method_missing on something that might just be a misspelled local variable.

Now imagine trying to distinguish between instance variables (prefix-@), class-variables (prefix-@@), global variables (prefix-$), Constants (first letter Capitol), method names and local variables (no prefix small case) by context alone.