-
Notifications
You must be signed in to change notification settings - Fork 94
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add fileIndex property to file object (#1186)
* Fix up tests * PR feedback to improve schema comment
- Loading branch information
1 parent
d3fff39
commit b0ffbe5
Showing
11 changed files
with
258 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| // Copyright (c) Microsoft. All Rights Reserved. | ||
| // Licensed under the MIT license. See LICENSE file in the project root for full license information. | ||
|
|
||
| using System; | ||
| using System.CodeDom.Compiler; | ||
| using System.Collections.Generic; | ||
| using System.Runtime.Serialization; | ||
| using Microsoft.CodeAnalysis.Sarif.Readers; | ||
| using Newtonsoft.Json; | ||
|
|
||
| namespace Microsoft.CodeAnalysis.Sarif | ||
| { | ||
| /// <summary> | ||
| /// Specifies the location of a file. | ||
| /// </summary> | ||
| [DataContract] | ||
| [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "0.58.0.0")] | ||
| public partial class FileLocation : PropertyBagHolder, ISarifNode | ||
| { | ||
| public static IEqualityComparer<FileLocation> ValueComparer => FileLocationEqualityComparer.Instance; | ||
|
|
||
| public bool ValueEquals(FileLocation other) => ValueComparer.Equals(this, other); | ||
| public int ValueGetHashCode() => ValueComparer.GetHashCode(this); | ||
|
|
||
| /// <summary> | ||
| /// Gets a value indicating the type of object implementing <see cref="ISarifNode" />. | ||
| /// </summary> | ||
| public SarifNodeKind SarifNodeKind | ||
| { | ||
| get | ||
| { | ||
| return SarifNodeKind.FileLocation; | ||
| } | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// A string containing a valid relative or absolute URI. | ||
| /// </summary> | ||
| [DataMember(Name = "uri", IsRequired = true)] | ||
| [JsonConverter(typeof(Microsoft.CodeAnalysis.Sarif.Readers.UriConverter))] | ||
| public Uri Uri { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted. | ||
| /// </summary> | ||
| [DataMember(Name = "uriBaseId", IsRequired = false, EmitDefaultValue = false)] | ||
| public string UriBaseId { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// The index within the run files array that specifies the file object associated with the file location. | ||
| /// </summary> | ||
| [DataMember(Name = "fileIndex", IsRequired = false, EmitDefaultValue = false)] | ||
| [JsonProperty(DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)] | ||
| [System.ComponentModel.DefaultValue(-1)] | ||
| public int FileIndex { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Key/value pairs that provide additional information about the file location. | ||
| /// </summary> | ||
| [DataMember(Name = "properties", IsRequired = false, EmitDefaultValue = false)] | ||
| internal override IDictionary<string, SerializedPropertyInfo> Properties { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Initializes a new instance of the <see cref="FileLocation" /> class. | ||
| /// </summary> | ||
| public FileLocation() | ||
| { | ||
| FileIndex = -1; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Initializes a new instance of the <see cref="FileLocation" /> class from the supplied values. | ||
| /// </summary> | ||
| /// <param name="uri"> | ||
| /// An initialization value for the <see cref="P: Uri" /> property. | ||
| /// </param> | ||
| /// <param name="uriBaseId"> | ||
| /// An initialization value for the <see cref="P: UriBaseId" /> property. | ||
| /// </param> | ||
| /// <param name="fileIndex"> | ||
| /// An initialization value for the <see cref="P: FileIndex" /> property. | ||
| /// </param> | ||
| /// <param name="properties"> | ||
| /// An initialization value for the <see cref="P: Properties" /> property. | ||
| /// </param> | ||
| public FileLocation(Uri uri, string uriBaseId, int fileIndex, IDictionary<string, SerializedPropertyInfo> properties) | ||
| { | ||
| Init(uri, uriBaseId, fileIndex, properties); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Initializes a new instance of the <see cref="FileLocation" /> class from the specified instance. | ||
| /// </summary> | ||
| /// <param name="other"> | ||
| /// The instance from which the new instance is to be initialized. | ||
| /// </param> | ||
| /// <exception cref="ArgumentNullException"> | ||
| /// Thrown if <paramref name="other" /> is null. | ||
| /// </exception> | ||
| public FileLocation(FileLocation other) | ||
| { | ||
| if (other == null) | ||
| { | ||
| throw new ArgumentNullException(nameof(other)); | ||
| } | ||
|
|
||
| Init(other.Uri, other.UriBaseId, other.FileIndex, other.Properties); | ||
| } | ||
|
|
||
| ISarifNode ISarifNode.DeepClone() | ||
| { | ||
| return DeepCloneCore(); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Creates a deep copy of this instance. | ||
| /// </summary> | ||
| public FileLocation DeepClone() | ||
| { | ||
| return (FileLocation)DeepCloneCore(); | ||
| } | ||
|
|
||
| private ISarifNode DeepCloneCore() | ||
| { | ||
| return new FileLocation(this); | ||
| } | ||
|
|
||
| private void Init(Uri uri, string uriBaseId, int fileIndex, IDictionary<string, SerializedPropertyInfo> properties) | ||
| { | ||
| if (uri != null) | ||
| { | ||
| Uri = new Uri(uri.OriginalString, uri.IsAbsoluteUri ? UriKind.Absolute : UriKind.Relative); | ||
| } | ||
|
|
||
| UriBaseId = uriBaseId; | ||
| FileIndex = fileIndex; | ||
| if (properties != null) | ||
| { | ||
| Properties = new Dictionary<string, SerializedPropertyInfo>(properties); | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.