Skip to content

Commit ba62b5f

Browse files
xoofxxoofx
committed
Rename ImageXXXHeader to PEXXXHeader
1 parent 6f97a43 commit ba62b5f

File tree

11 files changed

+107
-107
lines changed

11 files changed

+107
-107
lines changed

‎src/LibObjectFile/PE/Internal/RawImageOptionalHeaderCommonPart1.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright (c) Alexandre Mutel. All rights reserved.
1+
// Copyright (c) Alexandre Mutel. All rights reserved.
22
// This file is licensed under the BSD-Clause 2 license.
33
// See the license.txt file in the project root for more information.
44

@@ -17,7 +17,7 @@ internal struct RawImageOptionalHeaderCommonPart1
1717
/// <summary>
1818
/// The magic number, which identifies the file format. Expected to be 0x10b for PE32.
1919
/// </summary>
20-
public ImageOptionalHeaderMagic Magic;
20+
public PEOptionalHeaderMagic Magic;
2121

2222
/// <summary>
2323
/// The major version number of the linker.

src/LibObjectFile/PE/ImageCoffHeader.cs renamed to src/LibObjectFile/PE/PECoffHeader.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ namespace LibObjectFile.PE;
1212
/// Represents the COFF (Common Object File Format) header in a Portable Executable (PE) file.
1313
/// </summary>
1414
[StructLayout(LayoutKind.Sequential, Pack = 4)]
15-
public struct ImageCoffHeader
15+
public struct PECoffHeader
1616
{
1717
/// <summary>
1818
/// The machine type that the file is intended for.

src/LibObjectFile/PE/ImageDosHeader.cs renamed to src/LibObjectFile/PE/PEDosHeader.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ namespace LibObjectFile.PE;
1111
/// Represents the DOS header of a PE file.
1212
/// </summary>
1313
[StructLayout(LayoutKind.Sequential, Pack = 2)]
14-
public unsafe struct ImageDosHeader
14+
public unsafe struct PEDosHeader
1515
{
1616
/// <summary>
1717
/// Magic number. (Original DOS field is `e_magic`)
1818
/// </summary>
19-
public ImageDosMagic Magic;
19+
public PEDosMagic Magic;
2020

2121
/// <summary>
2222
/// Bytes on last page of file. (Original DOS field is `e_cblp`)

src/LibObjectFile/PE/ImageDosMagic.cs renamed to src/LibObjectFile/PE/PEDosMagic.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
// Copyright (c) Alexandre Mutel. All rights reserved.
1+
// Copyright (c) Alexandre Mutel. All rights reserved.
22
// This file is licensed under the BSD-Clause 2 license.
33
// See the license.txt file in the project root for more information.
44

55
namespace LibObjectFile.PE;
66

77
#pragma warning disable CS0649
88
/// <summary>
9-
/// Magic number for the <see cref="ImageDosHeader.Magic"/>>
9+
/// Magic number for the <see cref="PEDosHeader.Magic"/>>
1010
/// </summary>
11-
public enum ImageDosMagic : ushort
11+
public enum PEDosMagic : ushort
1212
{
1313
/// <summary>
1414
/// MZ - DOS executable file signature.

‎src/LibObjectFile/PE/PEFile.Read.cs‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -59,40 +59,40 @@ public static bool TryRead(Stream stream, [NotNullWhen(true)] out PEFile? peFile
5959

6060
public override unsafe void Read(PEImageReader reader)
6161
{
62-
Debug.Assert(Unsafe.SizeOf<ImageDosHeader>() == 64);
62+
Debug.Assert(Unsafe.SizeOf<PEDosHeader>() == 64);
6363

6464
var diagnostics = reader.Diagnostics;
6565
int read = reader.Read(MemoryMarshal.AsBytes(MemoryMarshal.CreateSpan(ref DosHeader, 1)));
66-
if (read != Unsafe.SizeOf<ImageDosHeader>())
66+
if (read != Unsafe.SizeOf<PEDosHeader>())
6767
{
6868
diagnostics.Error(DiagnosticId.PE_ERR_InvalidDosHeaderSize, "Invalid DOS header");
6969
return;
7070
}
7171

72-
if (DosHeader.Magic != ImageDosMagic.DOS)
72+
if (DosHeader.Magic != PEDosMagic.DOS)
7373
{
7474
diagnostics.Error(DiagnosticId.PE_ERR_InvalidDosHeaderMagic, "Invalid DOS header");
7575
return;
7676
}
7777

7878
var pePosition = DosHeader.FileAddressPEHeader;
7979

80-
if (pePosition < sizeof(ImageDosHeader))
80+
if (pePosition < sizeof(PEDosHeader))
8181
{
8282
if (pePosition < 4)
8383
{
8484
diagnostics.Error(DiagnosticId.PE_ERR_InvalidPEHeaderPosition, "Invalid PE header position");
8585
return;
8686
}
8787

88-
_unsafeNegativePEHeaderOffset = (int)pePosition - sizeof(ImageDosHeader);
88+
_unsafeNegativePEHeaderOffset = (int)pePosition - sizeof(PEDosHeader);
8989
}
9090
else
9191
{
9292
// Read the DOS stub
9393
var dosStubSize = DosHeader.SizeOfParagraphsHeader * 16;
9494

95-
if (dosStubSize + sizeof(ImageDosHeader) > pePosition)
95+
if (dosStubSize + sizeof(PEDosHeader) > pePosition)
9696
{
9797
diagnostics.Error(DiagnosticId.PE_ERR_InvalidDosStubSize, $"Invalid DOS stub size {dosStubSize} going beyond the PE header");
9898
return;
@@ -115,7 +115,7 @@ public override unsafe void Read(PEImageReader reader)
115115
_dosStub = [];
116116
}
117117

118-
var dosHeaderAndStubSize = sizeof(ImageDosHeader) + dosStubSize;
118+
var dosHeaderAndStubSize = sizeof(PEDosHeader) + dosStubSize;
119119

120120
// Read any DOS stub extra data (e.g Rich)
121121
if (dosHeaderAndStubSize < DosHeader.FileAddressPEHeader)
@@ -127,25 +127,25 @@ public override unsafe void Read(PEImageReader reader)
127127
// Read the PE header
128128
reader.Position = DosHeader.FileAddressPEHeader;
129129

130-
var signature = default(ImagePESignature);
130+
var signature = default(PESignature);
131131
read = reader.Read(MemoryMarshal.AsBytes(MemoryMarshal.CreateSpan(ref signature, 1)));
132-
if (read != sizeof(ImagePESignature))
132+
if (read != sizeof(PESignature))
133133
{
134134
diagnostics.Error(DiagnosticId.PE_ERR_InvalidPESignature, "Invalid PE signature");
135135
return;
136136
}
137137

138-
if (signature != ImagePESignature.PE)
138+
if (signature != PESignature.PE)
139139
{
140140
diagnostics.Error(DiagnosticId.PE_ERR_InvalidPESignature, $"Invalid PE signature 0x{(uint)signature:X8}");
141141
return;
142142
}
143143

144144
// Read the COFF header
145-
Debug.Assert(Unsafe.SizeOf<ImageCoffHeader>() == 20);
146-
var coffHeader = default(ImageCoffHeader);
145+
Debug.Assert(Unsafe.SizeOf<PECoffHeader>() == 20);
146+
var coffHeader = default(PECoffHeader);
147147
read = reader.Read(MemoryMarshal.AsBytes(MemoryMarshal.CreateSpan(ref coffHeader, 1)));
148-
if (read != Unsafe.SizeOf<ImageCoffHeader>())
148+
if (read != Unsafe.SizeOf<PECoffHeader>())
149149
{
150150
diagnostics.Error(DiagnosticId.PE_ERR_InvalidCoffHeaderSize, "Invalid COFF header");
151151
return;
@@ -155,22 +155,22 @@ public override unsafe void Read(PEImageReader reader)
155155
var positionAfterCoffHeader = reader.Position;
156156

157157
// Cannot be smaller than the magic
158-
if (CoffHeader.SizeOfOptionalHeader < sizeof(ImageOptionalHeaderMagic))
158+
if (CoffHeader.SizeOfOptionalHeader < sizeof(PEOptionalHeaderMagic))
159159
{
160160
diagnostics.Error(DiagnosticId.PE_ERR_InvalidOptionalHeaderSize, $"Invalid optional header size {CoffHeader.SizeOfOptionalHeader}");
161161
return;
162162
}
163163

164-
var magic = (ImageOptionalHeaderMagic)reader.ReadU16();
164+
var magic = (PEOptionalHeaderMagic)reader.ReadU16();
165165

166166
int minimumSizeOfOptionalHeaderToRead = 0;
167167

168168
// Process known PE32/PE32+ headers
169-
if (magic == ImageOptionalHeaderMagic.PE32)
169+
if (magic == PEOptionalHeaderMagic.PE32)
170170
{
171171
minimumSizeOfOptionalHeaderToRead = RawImageOptionalHeader32.MinimumSize;
172172
}
173-
else if (magic == ImageOptionalHeaderMagic.PE32Plus)
173+
else if (magic == PEOptionalHeaderMagic.PE32Plus)
174174
{
175175
minimumSizeOfOptionalHeaderToRead = RawImageOptionalHeader64.MinimumSize;
176176
}
@@ -184,17 +184,17 @@ public override unsafe void Read(PEImageReader reader)
184184
MemoryMarshal.Write(optionalHeader, (ushort)magic);
185185

186186
// We have already read the magic number
187-
var minimumSpan = optionalHeader.Slice(sizeof(ImageOptionalHeaderMagic));
187+
var minimumSpan = optionalHeader.Slice(sizeof(PEOptionalHeaderMagic));
188188
read = reader.Read(minimumSpan);
189189

190190
// The real size read (in case of tricked Tiny PE)
191-
optionalHeader = optionalHeader.Slice(0, read + sizeof(ImageOptionalHeaderMagic));
191+
optionalHeader = optionalHeader.Slice(0, read + sizeof(PEOptionalHeaderMagic));
192192

193193
Debug.Assert(Unsafe.SizeOf<RawImageOptionalHeader32>() == 224);
194194
Debug.Assert(Unsafe.SizeOf<RawImageOptionalHeader64>() == 240);
195195

196196
// Process known PE32/PE32+ headers
197-
if (magic == ImageOptionalHeaderMagic.PE32)
197+
if (magic == PEOptionalHeaderMagic.PE32)
198198
{
199199
var optionalHeader32 = new RawImageOptionalHeader32();
200200
var span = MemoryMarshal.AsBytes(MemoryMarshal.CreateSpan(ref optionalHeader32, 1));

‎src/LibObjectFile/PE/PEFile.Write.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ public override unsafe void Write(PEImageWriter writer)
6868

6969
// Update DOS header
7070
writer.Write(DosHeader);
71-
position += (uint)sizeof(ImageDosHeader);
71+
position += (uint)sizeof(PEDosHeader);
7272

7373
// Write DOS stub
7474
writer.Write(_dosStub);
@@ -86,12 +86,12 @@ public override unsafe void Write(PEImageWriter writer)
8686
position += (uint)zeroSize;
8787

8888
// PE00 header
89-
writer.Write(ImagePESignature.PE);
90-
position += sizeof(ImagePESignature); // PE00 header
89+
writer.Write(PESignature.PE);
90+
position += sizeof(PESignature); // PE00 header
9191

9292
// COFF header
9393
writer.Write(CoffHeader);
94-
position += (uint)sizeof(ImageCoffHeader);
94+
position += (uint)sizeof(PECoffHeader);
9595

9696

9797
if (IsPE32)

‎src/LibObjectFile/PE/PEFile.cs‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public sealed partial class PEFile : PEObjectBase
3131
/// <summary>
3232
/// Initializes a new instance of the <see cref="PEFile"/> class.
3333
/// </summary>
34-
public PEFile(ImageOptionalHeaderMagic magic = ImageOptionalHeaderMagic.PE32Plus)
34+
public PEFile(PEOptionalHeaderMagic magic = PEOptionalHeaderMagic.PE32Plus)
3535
{
3636
_sections = new(this);
3737
ExtraDataBeforeSections = new(this);
@@ -55,7 +55,7 @@ internal PEFile(bool unused)
5555
/// <summary>
5656
/// Gets the DOS header.
5757
/// </summary>
58-
public ImageDosHeader DosHeader;
58+
public PEDosHeader DosHeader;
5959

6060
/// <summary>
6161
/// Gets or sets an unsafe negative offset relative to the end of the DOS header.
@@ -67,9 +67,9 @@ public unsafe int UnsafeNegativePEHeaderOffset
6767
{
6868
// Should support Tiny PE layout http://www.phreedom.org/research/tinype/
6969
// Value must be >= sizeof(ImageDosHeader) - 4 and <= 0
70-
if (value < sizeof(ImageDosHeader) - 4 || value > 0)
70+
if (value < sizeof(PEDosHeader) - 4 || value > 0)
7171
{
72-
throw new ArgumentOutOfRangeException(nameof(value), $"PEHeaderOffset must be greater than {sizeof(ImageDosHeader)}");
72+
throw new ArgumentOutOfRangeException(nameof(value), $"PEHeaderOffset must be greater than {sizeof(PEDosHeader)}");
7373
}
7474

7575
if (value < 0 && (_dosStub.Length != 0 || (DosStubExtra is not null && DosStubExtra.Length > 0)))
@@ -120,22 +120,22 @@ public Stream? DosStubExtra
120120
/// <summary>
121121
/// Gets the COFF header.
122122
/// </summary>
123-
public ImageCoffHeader CoffHeader;
123+
public PECoffHeader CoffHeader;
124124

125125
/// <summary>
126126
/// Gets the optional header.
127127
/// </summary>
128-
public ImageOptionalHeader OptionalHeader;
128+
public PEOptionalHeader OptionalHeader;
129129

130130
/// <summary>
131131
/// Gets a boolean indicating whether this instance is a PE32 image.
132132
/// </summary>
133-
public bool IsPE32 => OptionalHeader.Magic == ImageOptionalHeaderMagic.PE32;
133+
public bool IsPE32 => OptionalHeader.Magic == PEOptionalHeaderMagic.PE32;
134134

135135
/// <summary>
136136
/// Gets a boolean indicating whether this instance is a PE32+ image.
137137
/// </summary>
138-
public bool IsPE32Plus => OptionalHeader.Magic == ImageOptionalHeaderMagic.PE32Plus;
138+
public bool IsPE32Plus => OptionalHeader.Magic == PEOptionalHeaderMagic.PE32Plus;
139139

140140
/// <summary>
141141
/// Gets the directories.
@@ -314,7 +314,7 @@ public override unsafe void UpdateLayout(PELayoutContext context)
314314
var position = 0U;
315315

316316
// Update DOS header
317-
position += (uint)sizeof(ImageDosHeader);
317+
position += (uint)sizeof(PEDosHeader);
318318
position += (uint)_dosStub.Length;
319319
position += (uint)(_dosStubExtra?.Length ?? 0U);
320320

@@ -324,10 +324,10 @@ public override unsafe void UpdateLayout(PELayoutContext context)
324324
// Update offset to PE header
325325
DosHeader._FileAddressPEHeader = position;
326326

327-
position += sizeof(ImagePESignature); // PE00 header
327+
position += sizeof(PESignature); // PE00 header
328328

329329
// COFF header
330-
position += (uint)sizeof(ImageCoffHeader);
330+
position += (uint)sizeof(PECoffHeader);
331331

332332
// TODO: update other DosHeader fields
333333

@@ -452,10 +452,10 @@ protected override bool PrintMembers(StringBuilder builder)
452452

453453
switch (OptionalHeader.Magic)
454454
{
455-
case ImageOptionalHeaderMagic.PE32:
455+
case PEOptionalHeaderMagic.PE32:
456456
builder.Append("PE32");
457457
break;
458-
case ImageOptionalHeaderMagic.PE32Plus:
458+
case PEOptionalHeaderMagic.PE32Plus:
459459
builder.Append("PE32+");
460460
break;
461461
}

src/LibObjectFile/PE/ImageOptionalHeader.cs renamed to src/LibObjectFile/PE/PEOptionalHeader.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
namespace LibObjectFile.PE;
1111

12-
public struct ImageOptionalHeader
12+
public struct PEOptionalHeader
1313
{
1414
internal RawImageOptionalHeaderCommonPart1 OptionalHeaderCommonPart1;
1515
internal RawImageOptionalHeaderBase32 OptionalHeaderBase32;
@@ -25,7 +25,7 @@ public struct ImageOptionalHeader
2525
/// <remarks>
2626
/// This value cannot be changed and must be set at construction time.
2727
/// </remarks>
28-
public ImageOptionalHeaderMagic Magic
28+
public PEOptionalHeaderMagic Magic
2929
{
3030
get => OptionalHeaderCommonPart1.Magic;
3131
}

src/LibObjectFile/PE/ImageOptionalHeaderMagic.cs renamed to src/LibObjectFile/PE/PEOptionalHeaderMagic.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
// Copyright (c) Alexandre Mutel. All rights reserved.
1+
// Copyright (c) Alexandre Mutel. All rights reserved.
22
// This file is licensed under the BSD-Clause 2 license.
33
// See the license.txt file in the project root for more information.
44

55
namespace LibObjectFile.PE;
66

7-
public enum ImageOptionalHeaderMagic : ushort
7+
public enum PEOptionalHeaderMagic : ushort
88
{
99
/// <summary>
1010
/// PE32

0 commit comments

Comments
 (0)