/interpreter/tags/at_build150307/src/edu/vub/at/objects/ATMethod.java

http://ambienttalk.googlecode.com/ · Java · 93 lines · 11 code · 7 blank · 75 comment · 0 complexity · 40ea94e0cc0366d7bfc19670078b2261 MD5 · raw file

  1. /**
  2. * AmbientTalk/2 Project
  3. * ATMethod.java created on Jul 24, 2006 at 9:42:24 PM
  4. * (c) Programming Technology Lab, 2006 - 2007
  5. * Authors: Tom Van Cutsem & Stijn Mostinckx
  6. *
  7. * Permission is hereby granted, free of charge, to any person
  8. * obtaining a copy of this software and associated documentation
  9. * files (the "Software"), to deal in the Software without
  10. * restriction, including without limitation the rights to use,
  11. * copy, modify, merge, publish, distribute, sublicense, and/or
  12. * sell copies of the Software, and to permit persons to whom the
  13. * Software is furnished to do so, subject to the following
  14. * conditions:
  15. *
  16. * The above copyright notice and this permission notice shall be
  17. * included in all copies or substantial portions of the Software.
  18. *
  19. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  20. * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
  21. * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  22. * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  23. * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  24. * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  25. * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  26. * OTHER DEALINGS IN THE SOFTWARE.
  27. */
  28. package edu.vub.at.objects;
  29. import edu.vub.at.exceptions.InterpreterException;
  30. import edu.vub.at.objects.grammar.ATBegin;
  31. import edu.vub.at.objects.grammar.ATSymbol;
  32. /**
  33. * ATMethods are ambienttalk's representation of methods as named functions. These
  34. * functions do not close over an environment allowing for them to be shared between
  35. * different clones. The environment is to be supplied during lookup (which wraps
  36. * ATMethods into ATClosures). As a consequence it is not possible to
  37. * get hold of an ATMethod at the base-level (since lookup implies wrapping)
  38. *
  39. * TODO: turn base_getxxx into meta_getxxx?
  40. *
  41. * @author smostinc
  42. * @author tvcutsem
  43. */
  44. public interface ATMethod extends ATObject {
  45. /**
  46. * Applies the method to the given arguments in the given context.
  47. * The context is usually supplied by a closure and is necessary in order to
  48. * pair a method with its current receiver (its 'self')
  49. *
  50. * The method itself is responsible for creating the appropriate 'call frame'
  51. * or activation record in which to define temporary variables and parameter bindings.
  52. *
  53. * @param arguments the actual arguments, already eagerly evaluated
  54. * @param ctx the context in which to evaluate the method body, call frame not yet inserted
  55. * @return the value of evaluating the method body in a context derived from the given context
  56. */
  57. public ATObject base_apply(ATTable arguments, ATContext ctx) throws InterpreterException;
  58. /**
  59. * Applies the method to the given arguments in the given context.
  60. * The context is usually supplied by a closure and is necessary in order to
  61. * pair a method with its current receiver (its 'self')
  62. *
  63. * The method will use the given context 'as-is', and will *not* insert an additional call frame.
  64. *
  65. * @param arguments the actual arguments, already eagerly evaluated
  66. * @param ctx the context in which to evaluate the method body, to be used without inserting a call frame
  67. * @return the value of evaluating the method body in the given context
  68. */
  69. public ATObject base_applyInScope(ATTable arguments, ATContext ctx) throws InterpreterException;
  70. /**
  71. * Structural access to the name of the method. Note that all methods (defined
  72. * using def name( ...args... ) { ... } of def foo: arg bar: arg { ... }) retain
  73. * the name with which they were first bound. Literal blocks which may be created
  74. * outside of a definition are implicitly named 'lambda'.
  75. */
  76. public ATSymbol base_getName() throws InterpreterException;
  77. /**
  78. * Structural access to the parameter list of the method,
  79. * which is normally a table of symbols.
  80. */
  81. public ATTable base_getParameters() throws InterpreterException;
  82. /**
  83. * Structural access to the body of the method.
  84. */
  85. public ATBegin base_getBodyExpression() throws InterpreterException;
  86. }