From dfb729d5f1e0420daa225a3ae6acfba9280e8aba Mon Sep 17 00:00:00 2001 From: TomyLobo Date: Thu, 24 Nov 2011 03:53:40 +0100 Subject: [PATCH] Added license blocks and element comments to all expression parser classes. Also updated some terminology --- .../expression/parser/ParserProcessors.java | 19 ++++++++++++++ .../expression/parser/UnaryOperator.java | 19 ++++++++++++++ .../worldedit/expression/runtime/Break.java | 24 ++++++++++++++++++ .../expression/runtime/BreakException.java | 25 +++++++++++++++++++ .../expression/runtime/Conditional.java | 24 ++++++++++++++++++ .../runtime/EvaluationException.java | 19 ++++++++++++++ .../worldedit/expression/runtime/For.java | 24 ++++++++++++++++++ .../expression/runtime/Function.java | 2 +- .../expression/runtime/LValueFunction.java | 2 +- .../worldedit/expression/runtime/Node.java | 2 +- .../worldedit/expression/runtime/Return.java | 24 ++++++++++++++++++ .../expression/runtime/ReturnException.java | 25 +++++++++++++++++++ .../expression/runtime/SimpleFor.java | 24 ++++++++++++++++++ .../worldedit/expression/runtime/While.java | 24 ++++++++++++++++++ 14 files changed, 254 insertions(+), 3 deletions(-) diff --git a/src/main/java/com/sk89q/worldedit/expression/parser/ParserProcessors.java b/src/main/java/com/sk89q/worldedit/expression/parser/ParserProcessors.java index 3c8f0d371..74d535265 100644 --- a/src/main/java/com/sk89q/worldedit/expression/parser/ParserProcessors.java +++ b/src/main/java/com/sk89q/worldedit/expression/parser/ParserProcessors.java @@ -1,3 +1,22 @@ +// $Id$ +/* + * WorldEdit + * Copyright (C) 2010, 2011 sk89q + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . +*/ + package com.sk89q.worldedit.expression.parser; import java.util.Collections; diff --git a/src/main/java/com/sk89q/worldedit/expression/parser/UnaryOperator.java b/src/main/java/com/sk89q/worldedit/expression/parser/UnaryOperator.java index 0c3915d16..3ef7d8028 100644 --- a/src/main/java/com/sk89q/worldedit/expression/parser/UnaryOperator.java +++ b/src/main/java/com/sk89q/worldedit/expression/parser/UnaryOperator.java @@ -1,3 +1,22 @@ +// $Id$ +/* + * WorldEdit + * Copyright (C) 2010, 2011 sk89q + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . +*/ + package com.sk89q.worldedit.expression.parser; import com.sk89q.worldedit.expression.lexer.tokens.OperatorToken; diff --git a/src/main/java/com/sk89q/worldedit/expression/runtime/Break.java b/src/main/java/com/sk89q/worldedit/expression/runtime/Break.java index 1c9d069b4..3a01fa4b3 100644 --- a/src/main/java/com/sk89q/worldedit/expression/runtime/Break.java +++ b/src/main/java/com/sk89q/worldedit/expression/runtime/Break.java @@ -1,5 +1,29 @@ +// $Id$ +/* + * WorldEdit + * Copyright (C) 2010, 2011 sk89q + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . +*/ + package com.sk89q.worldedit.expression.runtime; +/** + * A break or continue statement. + * + * @author TomyLobo + */ public class Break extends Node { boolean doContinue; diff --git a/src/main/java/com/sk89q/worldedit/expression/runtime/BreakException.java b/src/main/java/com/sk89q/worldedit/expression/runtime/BreakException.java index 3f83e4e58..97225074e 100644 --- a/src/main/java/com/sk89q/worldedit/expression/runtime/BreakException.java +++ b/src/main/java/com/sk89q/worldedit/expression/runtime/BreakException.java @@ -1,5 +1,30 @@ +// $Id$ +/* + * WorldEdit + * Copyright (C) 2010, 2011 sk89q + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . +*/ + package com.sk89q.worldedit.expression.runtime; +/** + * Thrown when a break or continue is encountered. + * Loop constructs catch this exception. + * + * @author TomyLobo + */ public class BreakException extends EvaluationException { private static final long serialVersionUID = 1L; diff --git a/src/main/java/com/sk89q/worldedit/expression/runtime/Conditional.java b/src/main/java/com/sk89q/worldedit/expression/runtime/Conditional.java index 1ffcbea95..b7a5a02c5 100644 --- a/src/main/java/com/sk89q/worldedit/expression/runtime/Conditional.java +++ b/src/main/java/com/sk89q/worldedit/expression/runtime/Conditional.java @@ -1,5 +1,29 @@ +// $Id$ +/* + * WorldEdit + * Copyright (C) 2010, 2011 sk89q + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . +*/ + package com.sk89q.worldedit.expression.runtime; +/** + * An if/else statement. + * + * @author TomyLobo + */ public class Conditional extends Node { RValue condition; RValue truePart; diff --git a/src/main/java/com/sk89q/worldedit/expression/runtime/EvaluationException.java b/src/main/java/com/sk89q/worldedit/expression/runtime/EvaluationException.java index 94c6fd1a1..75f6a7d36 100644 --- a/src/main/java/com/sk89q/worldedit/expression/runtime/EvaluationException.java +++ b/src/main/java/com/sk89q/worldedit/expression/runtime/EvaluationException.java @@ -1,3 +1,22 @@ +// $Id$ +/* + * WorldEdit + * Copyright (C) 2010, 2011 sk89q + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . +*/ + package com.sk89q.worldedit.expression.runtime; import com.sk89q.worldedit.expression.ExpressionException; diff --git a/src/main/java/com/sk89q/worldedit/expression/runtime/For.java b/src/main/java/com/sk89q/worldedit/expression/runtime/For.java index b135ba5ee..515fb2812 100644 --- a/src/main/java/com/sk89q/worldedit/expression/runtime/For.java +++ b/src/main/java/com/sk89q/worldedit/expression/runtime/For.java @@ -1,5 +1,29 @@ +// $Id$ +/* + * WorldEdit + * Copyright (C) 2010, 2011 sk89q + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . +*/ + package com.sk89q.worldedit.expression.runtime; +/** + * A Java/C-style for loop. + * + * @author TomyLobo + */ public class For extends Node { RValue init; RValue condition; diff --git a/src/main/java/com/sk89q/worldedit/expression/runtime/Function.java b/src/main/java/com/sk89q/worldedit/expression/runtime/Function.java index 711237324..1db489cdd 100644 --- a/src/main/java/com/sk89q/worldedit/expression/runtime/Function.java +++ b/src/main/java/com/sk89q/worldedit/expression/runtime/Function.java @@ -25,7 +25,7 @@ import java.lang.reflect.InvocationTargetException; import java.lang.reflect.Method; /** - * Wrapper for a Java method and its arguments (other Invokables) + * Wrapper for a Java method and its arguments (other Nodes) * * @author TomyLobo */ diff --git a/src/main/java/com/sk89q/worldedit/expression/runtime/LValueFunction.java b/src/main/java/com/sk89q/worldedit/expression/runtime/LValueFunction.java index 706ef77f4..82ee44c24 100644 --- a/src/main/java/com/sk89q/worldedit/expression/runtime/LValueFunction.java +++ b/src/main/java/com/sk89q/worldedit/expression/runtime/LValueFunction.java @@ -22,7 +22,7 @@ package com.sk89q.worldedit.expression.runtime; import java.lang.reflect.Method; /** - * Wrapper for a Java method and its arguments (other Invokables) + * Wrapper for a pair of Java methods and their arguments (other Nodes), forming an LValue * * @author TomyLobo */ diff --git a/src/main/java/com/sk89q/worldedit/expression/runtime/Node.java b/src/main/java/com/sk89q/worldedit/expression/runtime/Node.java index 169c73111..11e56ed4d 100644 --- a/src/main/java/com/sk89q/worldedit/expression/runtime/Node.java +++ b/src/main/java/com/sk89q/worldedit/expression/runtime/Node.java @@ -20,7 +20,7 @@ package com.sk89q.worldedit.expression.runtime; /** - * A value that can be used on the right side of an assignment. + * A node in the execution tree of an expression. * * @author TomyLobo */ diff --git a/src/main/java/com/sk89q/worldedit/expression/runtime/Return.java b/src/main/java/com/sk89q/worldedit/expression/runtime/Return.java index 7f3faa02b..30e97845d 100644 --- a/src/main/java/com/sk89q/worldedit/expression/runtime/Return.java +++ b/src/main/java/com/sk89q/worldedit/expression/runtime/Return.java @@ -1,5 +1,29 @@ +// $Id$ +/* + * WorldEdit + * Copyright (C) 2010, 2011 sk89q + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . +*/ + package com.sk89q.worldedit.expression.runtime; +/** + * A return statement. + * + * @author TomyLobo + */ public class Return extends Node { RValue value; diff --git a/src/main/java/com/sk89q/worldedit/expression/runtime/ReturnException.java b/src/main/java/com/sk89q/worldedit/expression/runtime/ReturnException.java index 208f1c87e..85c121b38 100644 --- a/src/main/java/com/sk89q/worldedit/expression/runtime/ReturnException.java +++ b/src/main/java/com/sk89q/worldedit/expression/runtime/ReturnException.java @@ -1,5 +1,30 @@ +// $Id$ +/* + * WorldEdit + * Copyright (C) 2010, 2011 sk89q + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . +*/ + package com.sk89q.worldedit.expression.runtime; +/** + * Thrown when a return statement is encountered. + * {@link com.sk89q.worldedit.expression.Expression#evaluate} catches this exception and returns the enclosed value. + * + * @author TomyLobo + */ public class ReturnException extends EvaluationException { private static final long serialVersionUID = 1L; diff --git a/src/main/java/com/sk89q/worldedit/expression/runtime/SimpleFor.java b/src/main/java/com/sk89q/worldedit/expression/runtime/SimpleFor.java index 463bb4e1b..44c43e775 100644 --- a/src/main/java/com/sk89q/worldedit/expression/runtime/SimpleFor.java +++ b/src/main/java/com/sk89q/worldedit/expression/runtime/SimpleFor.java @@ -1,5 +1,29 @@ +// $Id$ +/* + * WorldEdit + * Copyright (C) 2010, 2011 sk89q + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . +*/ + package com.sk89q.worldedit.expression.runtime; +/** + * A simple-style for loop. + * + * @author TomyLobo + */ public class SimpleFor extends Node { LValue counter; RValue first; diff --git a/src/main/java/com/sk89q/worldedit/expression/runtime/While.java b/src/main/java/com/sk89q/worldedit/expression/runtime/While.java index fb5c2a279..3f6e86200 100644 --- a/src/main/java/com/sk89q/worldedit/expression/runtime/While.java +++ b/src/main/java/com/sk89q/worldedit/expression/runtime/While.java @@ -1,5 +1,29 @@ +// $Id$ +/* + * WorldEdit + * Copyright (C) 2010, 2011 sk89q + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . +*/ + package com.sk89q.worldedit.expression.runtime; +/** + * A while loop. + * + * @author TomyLobo + */ public class While extends Node { RValue condition; RValue body;