diff options
10 files changed, 54 insertions, 13 deletions
diff --git a/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/core/AbstractChannel.java b/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/core/AbstractChannel.java index e79271b1a..0c42ad814 100644 --- a/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/core/AbstractChannel.java +++ b/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/core/AbstractChannel.java @@ -1167,6 +1167,7 @@ public abstract class AbstractChannel implements IChannel { * @param pos * @param len * @throws IOException + * @since 1.3 */ protected void write(byte[] buf, int pos, int len) throws IOException { assert Thread.currentThread() == out_thread; diff --git a/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/core/StreamChannel.java b/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/core/StreamChannel.java index 7ff555326..c527b0163 100644 --- a/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/core/StreamChannel.java +++ b/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/core/StreamChannel.java @@ -68,6 +68,9 @@ public abstract class StreamChannel extends AbstractChannel { for (byte b : buf) put(b & 0xff); } + /** + * @since 1.3 + */ protected void put(byte[] buf, int pos, int len) throws IOException { /* Default implementation - it is expected to be overridden */ int end = pos + len; diff --git a/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IBreakpoints.java b/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IBreakpoints.java index 6c8355873..4a551000b 100644 --- a/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IBreakpoints.java +++ b/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IBreakpoints.java @@ -67,7 +67,9 @@ public interface IBreakpoints extends IService { PROP_EVENT_TYPE = "EventType", // String PROP_EVENT_ARGS = "EventArgs", // String or Object PROP_CLIENT_DATA = "ClientData", // Object - PROP_ACTION = "Action", // String - expression or script + PROP_ACTION = "Action"; // String - expression or script + /** @since 1.3 */ + static final String PROP_SKIP_PROLOGUE = "SkipPrologue"; // Boolean /** @@ -127,13 +129,15 @@ public interface IBreakpoints extends IService { */ static final String INSTANCE_ERROR = "Error", // String - INSTANCE_CONDITION_ERROR = "ConditionError", // String INSTANCE_CONTEXT = "LocationContext", // String INSTANCE_ADDRESS = "Address", // Number INSTANCE_SIZE = "Size", // Number INSTANCE_TYPE = "BreakpointType", // String INSTANCE_MEMORY_CONTEXT = "MemoryContext",// String INSTANCE_HIT_COUNT = "HitCount"; // Number + /** @since 1.3 */ + static final String + INSTANCE_CONDITION_ERROR = "ConditionError"; // String /** * Breakpoint service capabilities. @@ -153,7 +157,9 @@ public interface IBreakpoints extends IService { CAPABILITY_TEMPORARY = "Temporary", // Boolean CAPABILITY_IGNORE_COUNT = "IgnoreCount", // Boolean CAPABILITY_ACCESS_MODE = "AccessMode", // Number - CAPABILITY_CLIENT_DATA = "ClientData", // Boolean + CAPABILITY_CLIENT_DATA = "ClientData"; // Boolean + /** @since 1.3 */ + static final String CAPABILITY_SKIP_PROLOGUE = "SkipPrologue"; // Boolean /** diff --git a/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IExpressions.java b/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IExpressions.java index 9f1996ff8..ce30de9c8 100644 --- a/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IExpressions.java +++ b/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IExpressions.java @@ -135,6 +135,7 @@ public interface IExpressions extends IService { /** * Value represents result of expression evaluation. * Note that same expression can be evaluated multiple times with different results. + * @noimplement This interface is not intended to be implemented by clients. */ interface Value { @@ -163,6 +164,7 @@ public interface IExpressions extends IService { * which value is unknown or optimized away, * even though the value it would point to is known. * @return true if the value is implicit pointer. + * @since 1.3 */ boolean isImplicitPointer(); @@ -204,12 +206,14 @@ public interface IExpressions extends IService { VAL_CLASS = "Class", VAL_TYPE = "Type", VAL_BIG_ENDIAN = "BigEndian", + VAL_REGISTER = "Register", + VAL_SYMBOL = "Symbol", + VAL_ADDRESS = "Address"; + /** @since 1.3 */ + static final String VAL_BINARY_SCALE = "BinaryScale", VAL_DECIMAL_SCALE = "DecimalScale", VAL_IMPLICIT_POINTER = "ImplicitPointer", - VAL_REGISTER = "Register", - VAL_SYMBOL = "Symbol", - VAL_ADDRESS = "Address", VAL_PIECES = "Pieces"; /** diff --git a/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/ILineNumbers.java b/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/ILineNumbers.java index d2bc8e09e..d77bb379b 100644 --- a/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/ILineNumbers.java +++ b/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/ILineNumbers.java @@ -69,6 +69,9 @@ public interface ILineNumbers extends IService { this.epilogue_begin = epilogue_begin; } + /** + * @since 1.3 + */ public CodeArea(Map<String,Object> area, CodeArea prev) { this(getString(area, "Dir", prev != null ? prev.directory : null), getString(area, "File", prev != null ? prev.file : null), diff --git a/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IMemory.java b/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IMemory.java index 4564905e0..0c1e338d0 100644 --- a/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IMemory.java +++ b/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IMemory.java @@ -42,7 +42,9 @@ public interface IMemory extends IService { PROP_NAME = "Name", /** String, name of the context, can be used for UI purposes */ PROP_START_BOUND = "StartBound", /** Number, lowest address (inclusive) which is valid for the context */ PROP_END_BOUND = "EndBound", /** Number, highest address (inclusive) which is valid for the context */ - PROP_ACCESS_TYPES = "AccessTypes", /** Array of String, the access types allowed for this context */ + PROP_ACCESS_TYPES = "AccessTypes"; /** Array of String, the access types allowed for this context */ + /** @since 1.3*/ + static final String PROP_ADDRESSABLE_UNIT_SIZE = "AddressableUnitSize", /** Number, addressable unit size in number of bytes */ PROP_DEFAULT_WORD_SIZE = "DefaultWordSize"; /** Number, default word size in number of bytes */ @@ -132,6 +134,9 @@ public interface IMemory extends IService { */ final static int MODE_VERIFY = 0x2; + /** + * @noimplement This interface is not intended to be implemented by clients. + */ interface MemoryContext { /** @@ -194,6 +199,7 @@ public interface IMemory extends IService { * The addressable size indicates the minimum number of bytes that * can be retrieved as a single unit. * @return addressable unit size in bytes. + * @since 1.3 */ int getAddressableUnitSize(); @@ -202,6 +208,7 @@ public interface IMemory extends IService { * The size is supposed to be used as the default memory view word representation. * Returns zero is word size is unknown. * @return word size in bytes. + * @since 1.3 */ int getDefaultWordSize(); diff --git a/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IProfiler.java b/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IProfiler.java index ac94b350c..0c94df64c 100644 --- a/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IProfiler.java +++ b/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IProfiler.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2013, 2014 Xilinx, Inc. and others. + * Copyright (c) 2013, 2015 Xilinx, Inc. and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -93,11 +93,13 @@ public interface IProfiler extends IService { * @param ctx - a context ID. * @param done - command result call back object. * @return - pending command handle. + * @since 1.3 */ IToken getCapabilities(String ctx, DoneGetCapabilities done); /** * Call back interface for 'getCapabilities' command. + * @since 1.3 */ interface DoneGetCapabilities { /** diff --git a/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IRunControl.java b/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IRunControl.java index 5c53acaa8..c2d4e2bc9 100644 --- a/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IRunControl.java +++ b/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IRunControl.java @@ -78,8 +78,10 @@ public interface IRunControl extends IService { /** Context ID of a symbols group that contains the context. * Members of a symbols group share same symbol reader configuration settings, * like user defined memory map entries and source lookup info */ - PROP_SYMBOLS_GROUP = "SymbolsGroup", + PROP_SYMBOLS_GROUP = "SymbolsGroup"; + /** @since 1.3 */ + static final String /** Array of String, the access types allowed for this context * when accessing context registers. */ @@ -230,6 +232,7 @@ public interface IRunControl extends IService { /** * Values of "RegAccessTypes". + * @since 1.3 */ static final String REG_ACCESS_RD_RUNNING = "rd-running", /** Context supports reading registers while running */ @@ -373,6 +376,7 @@ public interface IRunControl extends IService { * all services. In other words, all services access same hierarchy of contexts, * with same IDs, however, each service accesses its own subset of context's * attributes and functionality, which is relevant to that service. + * @noimplement This interface is not intended to be implemented by clients. */ interface RunControlContext { @@ -510,6 +514,7 @@ public interface IRunControl extends IService { /** * Get the register access types allowed for this context. * @return collection of access type names. + * @since 1.3 */ Collection<String> getRegAccessTypes(); diff --git a/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IStackTrace.java b/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IStackTrace.java index bb600841c..af3e70e76 100644 --- a/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IStackTrace.java +++ b/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IStackTrace.java @@ -195,6 +195,7 @@ public interface IStackTrace extends IService { /** * StackTraceContext represents stack trace objects - stacks and stack frames. + * @noimplement This interface is not intended to be implemented by clients. */ interface StackTraceContext { diff --git a/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/ISymbols.java b/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/ISymbols.java index ac1dd07a4..ac48eed5b 100644 --- a/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/ISymbols.java +++ b/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/ISymbols.java @@ -36,7 +36,9 @@ public interface ISymbols extends IService { comp_unit, // compilation unit block, // lexical block namespace, // C++ namespace + /** @since 1.3 */ variant_part, // a variant part of a structure + /** @since 1.3 */ variant // a member of a variant part of a structure } @@ -51,6 +53,7 @@ public interface ISymbols extends IService { enumeration, // enumeration type. function, // function type. member_pointer, // pointer to member type + /** @since 1.3 */ complex // complex float } @@ -80,13 +83,16 @@ public interface ISymbols extends IService { SYM_FLAG_ENUM_TYPE = 0x00400000, SYM_FLAG_STRUCT_TYPE = 0x00800000, SYM_FLAG_STRING_TYPE = 0x01000000, - SYM_FLAG_INHERITANCE = 0x02000000, + SYM_FLAG_INHERITANCE = 0x02000000; + /** @since 1.3 */ + static final int SYM_FLAG_BOOL_TYPE = 0x04000000, SYM_FLAG_INDIRECT = 0x08000000, SYM_FLAG_RVALUE = 0x10000000; /** * Symbol context interface. + * @noimplement This interface is not intended to be implemented by clients. */ interface Symbol { /** @@ -194,6 +200,7 @@ public interface ISymbols extends IService { /** * If symbol is an array type - return array stride in bits. * @return stride in bits. + * @since 1.3 */ Number getBitStride(); @@ -265,15 +272,17 @@ public interface ISymbols extends IService { PROP_LENGTH = "Length", PROP_LOWER_BOUND = "LowerBound", PROP_UPPER_BOUND = "UpperBound", - PROP_BIT_STRIDE = "BitStride", - PROP_BINARY_SCALE = "BinaryScale", - PROP_DECIMAL_SCALE = "DecimalScale", PROP_OFFSET = "Offset", PROP_ADDRESS = "Address", PROP_VALUE = "Value", PROP_BIG_ENDIAN = "BigEndian", PROP_REGISTER = "Register", PROP_FLAGS = "Flags"; + /** @since 1.3 */ + static final String + PROP_BIT_STRIDE = "BitStride", + PROP_BINARY_SCALE = "BinaryScale", + PROP_DECIMAL_SCALE = "DecimalScale"; /** * Symbol context properties update policies. |