| OLD | NEW |
| 1 <html> | 1 <html> |
| 2 <head> | 2 <head> |
| 3 <meta charset="UTF-8"/> | 3 <meta charset="UTF-8"/> |
| 4 <title>Analysis Server API Specification</title> | 4 <title>Analysis Server API Specification</title> |
| 5 </head> | 5 </head> |
| 6 <body> | 6 <body> |
| 7 <h1>Analysis Server API Specification</h1> | 7 <h1>Analysis Server API Specification</h1> |
| 8 <h1 style="color:#999999">WORKING DRAFT - Version <version>0.3</version></h1
> | 8 <h1 style="color:#999999">WORKING DRAFT - Version <version>0.3</version></h1
> |
| 9 <p> | 9 <p> |
| 10 This document contains a specification of the API provided by | 10 This document contains a specification of the API provided by |
| (...skipping 1206 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 1217 applied to the code. | 1217 applied to the code. |
| 1218 </p> | 1218 </p> |
| 1219 <request method="format"> | 1219 <request method="format"> |
| 1220 <p> | 1220 <p> |
| 1221 Format the contents of a single file. The currently selected region of | 1221 Format the contents of a single file. The currently selected region of |
| 1222 text is passed in so that the selection can be preserved across the | 1222 text is passed in so that the selection can be preserved across the |
| 1223 formatting operation. The updated selection will be as close to | 1223 formatting operation. The updated selection will be as close to |
| 1224 matching the original as possible, but whitespace at the beginning or | 1224 matching the original as possible, but whitespace at the beginning or |
| 1225 end of the selected region will be ignored. | 1225 end of the selected region will be ignored. |
| 1226 </p> | 1226 </p> |
| 1227 <p> |
| 1228 If a request is made for a file which does not exist, or |
| 1229 which is not currently subject to analysis (e.g. because it |
| 1230 is not associated with any analysis root specified to |
| 1231 analysis.setAnalysisRoots), an error of type |
| 1232 <tt>FORMAT_INVALID_FILE</tt> will be generated. |
| 1233 </p> |
| 1227 <params> | 1234 <params> |
| 1228 <field name="file"> | 1235 <field name="file"> |
| 1229 <ref>FilePath</ref> | 1236 <ref>FilePath</ref> |
| 1230 <p> | 1237 <p> |
| 1231 The file containing the code to be formatted. | 1238 The file containing the code to be formatted. |
| 1232 </p> | 1239 </p> |
| 1233 </field> | 1240 </field> |
| 1234 <field name="selectionOffset"> | 1241 <field name="selectionOffset"> |
| 1235 <ref>int</ref> | 1242 <ref>int</ref> |
| 1236 <p> | 1243 <p> |
| (...skipping 1716 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 2953 <enum> | 2960 <enum> |
| 2954 <value> | 2961 <value> |
| 2955 <code>CONTENT_MODIFIED</code> | 2962 <code>CONTENT_MODIFIED</code> |
| 2956 <p> | 2963 <p> |
| 2957 An "analysis.getErrors" or "analysis.getNavigation" request could | 2964 An "analysis.getErrors" or "analysis.getNavigation" request could |
| 2958 not be satisfied because the content of the file changed before | 2965 not be satisfied because the content of the file changed before |
| 2959 the requested results could be computed. | 2966 the requested results could be computed. |
| 2960 </p> | 2967 </p> |
| 2961 </value> | 2968 </value> |
| 2962 <value> | 2969 <value> |
| 2970 <code>FORMAT_INVALID_FILE</code> |
| 2971 <p> |
| 2972 An "edit.format" request specified a FilePath |
| 2973 which does not match a Dart file in an analysis root. |
| 2974 </p> |
| 2975 </value> |
| 2976 <value> |
| 2963 <code>GET_ERRORS_INVALID_FILE</code> | 2977 <code>GET_ERRORS_INVALID_FILE</code> |
| 2964 <p> | 2978 <p> |
| 2965 An "analysis.getErrors" request specified a FilePath | 2979 An "analysis.getErrors" request specified a FilePath |
| 2966 which does not match a file currently subject to | 2980 which does not match a file currently subject to |
| 2967 analysis. | 2981 analysis. |
| 2968 </p> | 2982 </p> |
| 2969 </value> | 2983 </value> |
| 2970 <value> | 2984 <value> |
| 2971 <code>INVALID_OVERLAY_CHANGE</code> | 2985 <code>INVALID_OVERLAY_CHANGE</code> |
| 2972 <p> | 2986 <p> |
| (...skipping 715 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 3688 <h2>Errors</h2> | 3702 <h2>Errors</h2> |
| 3689 <p> | 3703 <p> |
| 3690 This section contains a list of all of the errors that are | 3704 This section contains a list of all of the errors that are |
| 3691 produced by the server and the data that is returned with each. | 3705 produced by the server and the data that is returned with each. |
| 3692 </p> | 3706 </p> |
| 3693 <p> | 3707 <p> |
| 3694 TBD | 3708 TBD |
| 3695 </p> | 3709 </p> |
| 3696 </body> | 3710 </body> |
| 3697 </html> | 3711 </html> |
| OLD | NEW |