More documentation.

2026-09-26 15:30:46 +00:00 · 2024-08-08 19:27:14 +02:00
parent 7e5c89989f
commit 151609a8f5
697 changed files with 1121 additions and 1520 deletions
@@ -17,17 +17,13 @@
 package com.jpexs.decompiler.graph.model;

 import com.jpexs.decompiler.flash.SourceGeneratorLocalData;
-import com.jpexs.decompiler.graph.CompilationException;
-import com.jpexs.decompiler.graph.GraphSourceItem;
-import com.jpexs.decompiler.graph.GraphSourceItemPos;
-import com.jpexs.decompiler.graph.GraphTargetItem;
-import com.jpexs.decompiler.graph.SourceGenerator;
-import com.jpexs.decompiler.graph.TypeItem;
+import com.jpexs.decompiler.graph.*;
+
 import java.util.ArrayList;
 import java.util.List;

 /**
- *
+ * Logical AND.
 * @author JPEXS
 */
 public class AndItem extends BinaryOpItem implements CompoundableBinaryOp {
@@ -21,7 +21,7 @@ import com.jpexs.decompiler.graph.GraphTargetItem;
 import com.jpexs.decompiler.graph.TypeItem;

 /**
- *
+ * Any item.
 * @author JPEXS
 */
 public class AnyItem extends GraphTargetItem {
@@ -18,10 +18,12 @@ package com.jpexs.decompiler.graph.model;

 import com.jpexs.decompiler.graph.GraphSourceItem;
 import com.jpexs.decompiler.graph.GraphTargetItem;
+
 import java.util.List;

 /**
- *
+ * Binary operation interface.
+ * Operation on two operands.
 * @author JPEXS
 */
 public interface BinaryOp {
@@ -17,18 +17,15 @@
 package com.jpexs.decompiler.graph.model;

 import com.jpexs.decompiler.flash.helpers.GraphTextWriter;
-import com.jpexs.decompiler.graph.GraphPart;
-import com.jpexs.decompiler.graph.GraphSourceItem;
-import com.jpexs.decompiler.graph.GraphSourceItemPos;
-import com.jpexs.decompiler.graph.GraphTargetItem;
-import com.jpexs.decompiler.graph.GraphTargetVisitorInterface;
-import com.jpexs.decompiler.graph.SimpleValue;
+import com.jpexs.decompiler.graph.*;
+
 import java.util.List;
 import java.util.Objects;
 import java.util.Set;

 /**
- *
+ * Binary operation.
+ * Operation on two operands.
 * @author JPEXS
 */
 public abstract class BinaryOpItem extends GraphTargetItem implements BinaryOp {
@@ -18,17 +18,12 @@ package com.jpexs.decompiler.graph.model;

 import com.jpexs.decompiler.flash.SourceGeneratorLocalData;
 import com.jpexs.decompiler.flash.helpers.GraphTextWriter;
-import com.jpexs.decompiler.graph.CompilationException;
-import com.jpexs.decompiler.graph.Graph;
-import com.jpexs.decompiler.graph.GraphSourceItem;
-import com.jpexs.decompiler.graph.GraphTargetItem;
-import com.jpexs.decompiler.graph.GraphTargetVisitorInterface;
-import com.jpexs.decompiler.graph.SourceGenerator;
-import com.jpexs.decompiler.graph.TypeItem;
+import com.jpexs.decompiler.graph.*;
+
 import java.util.List;

 /**
- *
+ * Block.
 * @author JPEXS
 */
 public class BlockItem extends GraphTargetItem {
@@ -18,7 +18,7 @@ package com.jpexs.decompiler.graph.model;

 /**
 * An item which is passed on top of the stack when processing if branches or
- * loop body. This is actually a hack to process AS1/2 for..in clauses
+ * loop body. This is actually a hack to process AS1/2 for..in clauses.
 *
 * @author JPEXS
 */
@@ -19,15 +19,12 @@ package com.jpexs.decompiler.graph.model;
 import com.jpexs.decompiler.flash.SourceGeneratorLocalData;
 import com.jpexs.decompiler.flash.helpers.GraphTextWriter;
 import com.jpexs.decompiler.flash.helpers.NulWriter;
-import com.jpexs.decompiler.graph.CompilationException;
-import com.jpexs.decompiler.graph.GraphSourceItem;
-import com.jpexs.decompiler.graph.GraphTargetItem;
-import com.jpexs.decompiler.graph.SourceGenerator;
-import com.jpexs.decompiler.graph.TypeItem;
+import com.jpexs.decompiler.graph.*;
+
 import java.util.List;

 /**
- *
+ * Break statement.
 * @author JPEXS
 */
 public class BreakItem extends GraphTargetItem {
@@ -19,7 +19,7 @@ package com.jpexs.decompiler.graph.model;
 import java.util.List;

 /**
- *
+ * Callable interface.
 * @author JPEXS
 */
 public interface Callable {
@@ -18,16 +18,12 @@ package com.jpexs.decompiler.graph.model;

 import com.jpexs.decompiler.flash.SourceGeneratorLocalData;
 import com.jpexs.decompiler.flash.helpers.GraphTextWriter;
-import com.jpexs.decompiler.graph.CompilationException;
-import com.jpexs.decompiler.graph.GraphSourceItem;
-import com.jpexs.decompiler.graph.GraphTargetItem;
-import com.jpexs.decompiler.graph.GraphTargetVisitorInterface;
-import com.jpexs.decompiler.graph.SourceGenerator;
-import com.jpexs.decompiler.graph.TypeItem;
+import com.jpexs.decompiler.graph.*;
+
 import java.util.List;

 /**
- *
+ * Comma expression.
 * @author JPEXS
 */
 public class CommaExpressionItem extends GraphTargetItem {
@@ -21,7 +21,7 @@ import com.jpexs.decompiler.graph.GraphTargetItem;
 import com.jpexs.decompiler.graph.TypeItem;

 /**
- *
+ * Comment item.
 * @author JPEXS
 */
 public class CommentItem extends GraphTargetItem {
@@ -17,7 +17,7 @@
 package com.jpexs.decompiler.graph.model;

 /**
- *
+ * Compoundable binary operation interface.
 * @author JPEXS
 */
 public interface CompoundableBinaryOp extends BinaryOp {
@@ -19,15 +19,12 @@ package com.jpexs.decompiler.graph.model;
 import com.jpexs.decompiler.flash.SourceGeneratorLocalData;
 import com.jpexs.decompiler.flash.helpers.GraphTextWriter;
 import com.jpexs.decompiler.flash.helpers.NulWriter;
-import com.jpexs.decompiler.graph.CompilationException;
-import com.jpexs.decompiler.graph.GraphSourceItem;
-import com.jpexs.decompiler.graph.GraphTargetItem;
-import com.jpexs.decompiler.graph.SourceGenerator;
-import com.jpexs.decompiler.graph.TypeItem;
+import com.jpexs.decompiler.graph.*;
+
 import java.util.List;

 /**
- *
+ * Continue statement.
 * @author JPEXS
 */
 public class ContinueItem extends GraphTargetItem {
@@ -20,6 +20,9 @@ import com.jpexs.decompiler.flash.helpers.GraphTextWriter;
 import com.jpexs.decompiler.graph.GraphTargetItem;
 import com.jpexs.decompiler.graph.TypeItem;

+/**
+ * Default section of a Switch statement.
+ */
 public class DefaultItem extends GraphTargetItem {

    @Override
@@ -32,7 +32,7 @@ import java.util.ArrayList;
 import java.util.List;

 /**
- *
+ * Do-while loop.
 * @author JPEXS
 */
 public class DoWhileItem extends LoopItem implements Block {
@@ -28,7 +28,7 @@ import java.util.List;
 import java.util.Set;

 /**
- *
+ * Duplicate item.
 * @author JPEXS
 */
 public class DuplicateItem extends GraphTargetItem implements SimpleValue {
@@ -21,7 +21,7 @@ import com.jpexs.decompiler.graph.GraphTargetItem;
 import com.jpexs.decompiler.graph.TypeItem;

 /**
- *
+ * Empty command.
 * @author JPEXS
 */
 public class EmptyCommand extends GraphTargetItem {
@@ -17,7 +17,8 @@
 package com.jpexs.decompiler.graph.model;

 /**
- *
+ * Exit item interface.
+ * Commands like return, throw, etc...
 * @author JPEXS
 */
 public interface ExitItem {
@@ -28,7 +28,7 @@ import java.util.List;
 import java.util.Set;

 /**
- *
+ * False value.
 * @author JPEXS
 */
 public class FalseItem extends GraphTargetItem implements LogicalOpItem, SimpleValue {
@@ -32,7 +32,7 @@ import java.util.ArrayList;
 import java.util.List;

 /**
- *
+ * For loop.
 * @author JPEXS
 */
 public class ForItem extends LoopItem implements Block {
@@ -26,7 +26,7 @@ import java.util.ArrayList;
 import java.util.List;

 /**
- *
+ * Goto.
 * @author JPEXS
 */
 public class GotoItem extends GraphTargetItem implements Block {
@@ -32,7 +32,7 @@ import java.util.List;
 import java.util.Set;

 /**
- *
+ * If statement.
 * @author JPEXS
 */
 public class IfItem extends GraphTargetItem implements Block {
@@ -23,7 +23,7 @@ import com.jpexs.decompiler.graph.TypeItem;
 import java.util.Set;

 /**
- *
+ * Integer value.
 * @author JPEXS
 */
 public class IntegerValueItem extends GraphTargetItem implements IntegerValueTypeItem {
@@ -17,7 +17,7 @@
 package com.jpexs.decompiler.graph.model;

 /**
- *
+ * Interface for items that have integer value type.
 * @author JPEXS
 */
 public interface IntegerValueTypeItem {
@@ -22,7 +22,7 @@ import com.jpexs.decompiler.graph.GraphTargetItem;
 import com.jpexs.decompiler.graph.TypeItem;

 /**
- *
+ * Label.
 * @author JPEXS
 */
 public class LabelItem extends GraphTargetItem {
@@ -28,7 +28,7 @@ import java.util.List;
 import java.util.Set;

 /**
- *
+ * Local data for decompilation.
 * @author JPEXS
 */
 public class LocalData {
@@ -20,7 +20,7 @@ import com.jpexs.decompiler.graph.GraphSourceItem;
 import com.jpexs.decompiler.graph.GraphTargetItem;

 /**
- *
+ * Logical operation item interface.
 * @author JPEXS
 */
 public interface LogicalOpItem {
@@ -22,7 +22,7 @@ import com.jpexs.decompiler.graph.Loop;
 import java.util.List;

 /**
- *
+ * Base class for loops.
 * @author JPEXS
 */
 public abstract class LoopItem extends GraphTargetItem {
@@ -30,7 +30,7 @@ import java.util.List;
 import java.util.Set;

 /**
- *
+ * Logical NOT.
 * @author JPEXS
 */
 public class NotItem extends UnaryOpItem implements LogicalOpItem, Inverted {
@@ -27,7 +27,7 @@ import java.util.ArrayList;
 import java.util.List;

 /**
- *
+ * Logical OR.
 * @author JPEXS
 */
 public class OrItem extends BinaryOpItem implements CompoundableBinaryOp {
@@ -25,7 +25,7 @@ import com.jpexs.decompiler.graph.SourceGenerator;
 import java.util.List;

 /**
- *
+ * Parenthesis.
 * @author JPEXS
 */
 public class ParenthesisItem extends GraphTargetItem {
@@ -27,7 +27,7 @@ import com.jpexs.decompiler.graph.TypeItem;
 import java.util.List;

 /**
- *
+ * Pop item from the stack.
 * @author JPEXS
 */
 public class PopItem extends GraphTargetItem {
@@ -27,7 +27,7 @@ import java.util.List;
 import java.util.Objects;

 /**
- *
+ * Push item on the stack.
 * @author JPEXS
 */
 public class PushItem extends GraphTargetItem {
@@ -21,7 +21,7 @@ import com.jpexs.decompiler.graph.GraphTargetItem;
 import com.jpexs.decompiler.graph.TypeItem;

 /**
- *
+ * Script end.
 * @author JPEXS
 */
 public class ScriptEndItem extends GraphTargetItem implements ExitItem {
@@ -32,7 +32,7 @@ import java.util.ArrayList;
 import java.util.List;

 /**
- *
+ * Switch statement.
 * @author JPEXS
 */
 public class SwitchItem extends LoopItem implements Block {
@@ -28,7 +28,7 @@ import java.util.List;
 import java.util.Objects;

 /**
- *
+ * Ternar operator.
 * @author JPEXS
 */
 public class TernarOpItem extends GraphTargetItem {
@@ -28,7 +28,7 @@ import java.util.List;
 import java.util.Set;

 /**
- *
+ * True value.
 * @author JPEXS
 */
 public class TrueItem extends GraphTargetItem implements LogicalOpItem, SimpleValue {
@@ -19,7 +19,7 @@ package com.jpexs.decompiler.graph.model;
 import com.jpexs.decompiler.graph.GraphTargetItem;

 /**
- *
+ * Unary operator interface.
 * @author JPEXS
 */
 public interface UnaryOp {
@@ -25,7 +25,7 @@ import java.util.Objects;
 import java.util.Set;

 /**
- *
+ * Unary operator.
 * @author JPEXS
 */
 public abstract class UnaryOpItem extends GraphTargetItem implements UnaryOp {
@@ -21,7 +21,7 @@ import com.jpexs.decompiler.flash.helpers.GraphTextWriter;
 import com.jpexs.decompiler.graph.GraphTargetItem;

 /**
- *
+ * Unbounded type.
 * @author JPEXS
 */
 public class UnboundedTypeItem extends AVM2Item {
@@ -24,7 +24,7 @@ import java.util.ArrayList;
 import java.util.List;

 /**
- *
+ * Universal loop.
 * @author JPEXS
 */
 public class UniversalLoopItem extends WhileItem implements Block {
@@ -32,7 +32,7 @@ import java.util.ArrayList;
 import java.util.List;

 /**
- *
+ * While statement.
 * @author JPEXS
 */
 public class WhileItem extends LoopItem implements Block {