Skip to content

Commit 944a9de

Browse files
vasildvasild
committed
net: remove CNetAddr::ToString() and use ToStringAddr() instead
Both methods do the same thing, so simplify to having just one. Further, `CService` inherits `CNetAddr` and `CService::ToString()` overrides `CNetAddr::ToString()` but the latter is not virtual which may be confusing. Avoid such a confusion by not having non-virtual methods with the same names in inheritance.
1 parent 043b9de commit 944a9de

File tree

9 files changed

+26
-33
lines changed

9 files changed

+26
-33
lines changed

‎src/addrman.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -681,7 +681,7 @@ bool AddrManImpl::Add_(const std::vector<CAddress>& vAddr, const CNetAddr& sourc
681681
added += AddSingle(*it, source, time_penalty) ? 1 : 0;
682682
}
683683
if (added > 0) {
684-
LogPrint(BCLog::ADDRMAN, "Added %i addresses (of %i) from %s: %i tried, %i new\n", added, vAddr.size(), source.ToString(), nTried, nNew);
684+
LogPrint(BCLog::ADDRMAN, "Added %i addresses (of %i) from %s: %i tried, %i new\n", added, vAddr.size(), source.ToStringAddr(), nTried, nNew);
685685
}
686686
return added > 0;
687687
}

‎src/mapport.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ static bool ProcessUpnp()
181181
if (externalIPAddress[0]) {
182182
CNetAddr resolved;
183183
if (LookupHost(externalIPAddress, resolved, false)) {
184-
LogPrintf("UPnP: ExternalIPAddress = %s\n", resolved.ToString());
184+
LogPrintf("UPnP: ExternalIPAddress = %s\n", resolved.ToStringAddr());
185185
AddLocal(resolved, LOCAL_MAPPED);
186186
}
187187
} else {

‎src/net.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2156,7 +2156,7 @@ void Discover()
21562156
for (const CNetAddr &addr : vaddr)
21572157
{
21582158
if (AddLocal(addr, LOCAL_IF))
2159-
LogPrintf("%s: %s - %s\n", __func__, pszHostName, addr.ToString());
2159+
LogPrintf("%s: %s - %s\n", __func__, pszHostName, addr.ToStringAddr());
21602160
}
21612161
}
21622162
}
@@ -2176,14 +2176,14 @@ void Discover()
21762176
struct sockaddr_in* s4 = (struct sockaddr_in*)(ifa->ifa_addr);
21772177
CNetAddr addr(s4->sin_addr);
21782178
if (AddLocal(addr, LOCAL_IF))
2179-
LogPrintf("%s: IPv4 %s: %s\n", __func__, ifa->ifa_name, addr.ToString());
2179+
LogPrintf("%s: IPv4 %s: %s\n", __func__, ifa->ifa_name, addr.ToStringAddr());
21802180
}
21812181
else if (ifa->ifa_addr->sa_family == AF_INET6)
21822182
{
21832183
struct sockaddr_in6* s6 = (struct sockaddr_in6*)(ifa->ifa_addr);
21842184
CNetAddr addr(s6->sin6_addr);
21852185
if (AddLocal(addr, LOCAL_IF))
2186-
LogPrintf("%s: IPv6 %s: %s\n", __func__, ifa->ifa_name, addr.ToString());
2186+
LogPrintf("%s: IPv6 %s: %s\n", __func__, ifa->ifa_name, addr.ToStringAddr());
21872187
}
21882188
}
21892189
freeifaddrs(myaddrs);

‎src/netaddress.cpp

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -622,11 +622,6 @@ std::string CNetAddr::ToStringAddr() const
622622
assert(false);
623623
}
624624

625-
std::string CNetAddr::ToString() const
626-
{
627-
return ToStringAddr();
628-
}
629-
630625
bool operator==(const CNetAddr& a, const CNetAddr& b)
631626
{
632627
return a.m_net == b.m_net && a.m_addr == b.m_addr;
@@ -1098,7 +1093,7 @@ std::string CSubNet::ToString() const
10981093
break;
10991094
}
11001095

1101-
return network.ToString() + suffix;
1096+
return network.ToStringAddr() + suffix;
11021097
}
11031098

11041099
bool CSubNet::IsValid() const

‎src/netaddress.h

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,6 @@ class CNetAddr
193193
bool IsAddrV1Compatible() const;
194194

195195
enum Network GetNetwork() const;
196-
std::string ToString() const;
197196
std::string ToStringAddr() const;
198197
bool GetInAddr(struct in_addr* pipv4Addr) const;
199198
Network GetNetClass() const;

‎src/rpc/net.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -661,7 +661,7 @@ static RPCHelpMan getnetworkinfo()
661661
for (const std::pair<const CNetAddr, LocalServiceInfo> &item : mapLocalHost)
662662
{
663663
UniValue rec(UniValue::VOBJ);
664-
rec.pushKV("address", item.first.ToString());
664+
rec.pushKV("address", item.first.ToStringAddr());
665665
rec.pushKV("port", item.second.nPort);
666666
rec.pushKV("score", item.second.nScore);
667667
localAddresses.push_back(rec);

‎src/test/fuzz/netaddress.cpp

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,6 @@ FUZZ_TARGET(netaddress)
7070
assert(net_addr.GetNetwork() == Network::NET_ONION);
7171
}
7272
(void)net_addr.IsValid();
73-
(void)net_addr.ToString();
7473
(void)net_addr.ToStringAddr();
7574

7675
const CSubNet sub_net{net_addr, fuzzed_data_provider.ConsumeIntegral<uint8_t>()};

‎src/test/net_tests.cpp

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ BOOST_AUTO_TEST_CASE(cnetaddr_basic)
141141

142142
BOOST_CHECK(addr.IsBindAny());
143143
BOOST_CHECK(addr.IsAddrV1Compatible());
144-
BOOST_CHECK_EQUAL(addr.ToString(), "0.0.0.0");
144+
BOOST_CHECK_EQUAL(addr.ToStringAddr(), "0.0.0.0");
145145

146146
// IPv4, INADDR_NONE
147147
BOOST_REQUIRE(LookupHost("255.255.255.255", addr, false));
@@ -150,7 +150,7 @@ BOOST_AUTO_TEST_CASE(cnetaddr_basic)
150150

151151
BOOST_CHECK(!addr.IsBindAny());
152152
BOOST_CHECK(addr.IsAddrV1Compatible());
153-
BOOST_CHECK_EQUAL(addr.ToString(), "255.255.255.255");
153+
BOOST_CHECK_EQUAL(addr.ToStringAddr(), "255.255.255.255");
154154

155155
// IPv4, casual
156156
BOOST_REQUIRE(LookupHost("12.34.56.78", addr, false));
@@ -159,7 +159,7 @@ BOOST_AUTO_TEST_CASE(cnetaddr_basic)
159159

160160
BOOST_CHECK(!addr.IsBindAny());
161161
BOOST_CHECK(addr.IsAddrV1Compatible());
162-
BOOST_CHECK_EQUAL(addr.ToString(), "12.34.56.78");
162+
BOOST_CHECK_EQUAL(addr.ToStringAddr(), "12.34.56.78");
163163

164164
// IPv6, in6addr_any
165165
BOOST_REQUIRE(LookupHost("::", addr, false));
@@ -168,7 +168,7 @@ BOOST_AUTO_TEST_CASE(cnetaddr_basic)
168168

169169
BOOST_CHECK(addr.IsBindAny());
170170
BOOST_CHECK(addr.IsAddrV1Compatible());
171-
BOOST_CHECK_EQUAL(addr.ToString(), "::");
171+
BOOST_CHECK_EQUAL(addr.ToStringAddr(), "::");
172172

173173
// IPv6, casual
174174
BOOST_REQUIRE(LookupHost("1122:3344:5566:7788:9900:aabb:ccdd:eeff", addr, false));
@@ -177,7 +177,7 @@ BOOST_AUTO_TEST_CASE(cnetaddr_basic)
177177

178178
BOOST_CHECK(!addr.IsBindAny());
179179
BOOST_CHECK(addr.IsAddrV1Compatible());
180-
BOOST_CHECK_EQUAL(addr.ToString(), "1122:3344:5566:7788:9900:aabb:ccdd:eeff");
180+
BOOST_CHECK_EQUAL(addr.ToStringAddr(), "1122:3344:5566:7788:9900:aabb:ccdd:eeff");
181181

182182
// IPv6, scoped/link-local. See https://tools.ietf.org/html/rfc4007
183183
// We support non-negative decimal integers (uint32_t) as zone id indices.
@@ -190,14 +190,14 @@ BOOST_AUTO_TEST_CASE(cnetaddr_basic)
190190
BOOST_REQUIRE(addr.IsValid());
191191
BOOST_REQUIRE(addr.IsIPv6());
192192
BOOST_CHECK(!addr.IsBindAny());
193-
BOOST_CHECK_EQUAL(addr.ToString(), scoped_addr);
193+
BOOST_CHECK_EQUAL(addr.ToStringAddr(), scoped_addr);
194194

195195
// Test that the delimiter "%" and default zone id of 0 can be omitted for the default scope.
196196
BOOST_REQUIRE(LookupHost(link_local + "%0", addr, false));
197197
BOOST_REQUIRE(addr.IsValid());
198198
BOOST_REQUIRE(addr.IsIPv6());
199199
BOOST_CHECK(!addr.IsBindAny());
200-
BOOST_CHECK_EQUAL(addr.ToString(), link_local);
200+
BOOST_CHECK_EQUAL(addr.ToStringAddr(), link_local);
201201

202202
// TORv2, no longer supported
203203
BOOST_CHECK(!addr.SetSpecial("6hzph5hv6337r6p2.onion"));
@@ -211,7 +211,7 @@ BOOST_AUTO_TEST_CASE(cnetaddr_basic)
211211
BOOST_CHECK(!addr.IsI2P());
212212
BOOST_CHECK(!addr.IsBindAny());
213213
BOOST_CHECK(!addr.IsAddrV1Compatible());
214-
BOOST_CHECK_EQUAL(addr.ToString(), torv3_addr);
214+
BOOST_CHECK_EQUAL(addr.ToStringAddr(), torv3_addr);
215215

216216
// TORv3, broken, with wrong checksum
217217
BOOST_CHECK(!addr.SetSpecial("pg6mmjiyjmcrsslvykfwnntlaru7p5svn6y2ymmju6nubxndf4pscsad.onion"));
@@ -238,7 +238,7 @@ BOOST_AUTO_TEST_CASE(cnetaddr_basic)
238238
BOOST_CHECK(!addr.IsTor());
239239
BOOST_CHECK(!addr.IsBindAny());
240240
BOOST_CHECK(!addr.IsAddrV1Compatible());
241-
BOOST_CHECK_EQUAL(addr.ToString(), ToLower(i2p_addr));
241+
BOOST_CHECK_EQUAL(addr.ToStringAddr(), ToLower(i2p_addr));
242242

243243
// I2P, correct length, but decodes to less than the expected number of bytes.
244244
BOOST_CHECK(!addr.SetSpecial("udhdrtrcetjm5sxzskjyr5ztpeszydbh4dpl3pl4utgqqw2v4jn=.b32.i2p"));
@@ -265,7 +265,7 @@ BOOST_AUTO_TEST_CASE(cnetaddr_basic)
265265

266266
BOOST_CHECK(!addr.IsBindAny());
267267
BOOST_CHECK(addr.IsAddrV1Compatible());
268-
BOOST_CHECK_EQUAL(addr.ToString(), "esffpvrt3wpeaygy.internal");
268+
BOOST_CHECK_EQUAL(addr.ToStringAddr(), "esffpvrt3wpeaygy.internal");
269269

270270
// Totally bogus
271271
BOOST_CHECK(!addr.SetSpecial("totally bogus"));
@@ -321,7 +321,7 @@ BOOST_AUTO_TEST_CASE(cnetaddr_tostring_canonical_ipv6)
321321
CNetAddr net_addr;
322322
BOOST_REQUIRE(LookupHost(input_address, net_addr, false));
323323
BOOST_REQUIRE(net_addr.IsIPv6());
324-
BOOST_CHECK_EQUAL(net_addr.ToString(), expected_canonical_representation_output);
324+
BOOST_CHECK_EQUAL(net_addr.ToStringAddr(), expected_canonical_representation_output);
325325
}
326326
}
327327

@@ -410,7 +410,7 @@ BOOST_AUTO_TEST_CASE(cnetaddr_unserialize_v2)
410410
BOOST_CHECK(addr.IsValid());
411411
BOOST_CHECK(addr.IsIPv4());
412412
BOOST_CHECK(addr.IsAddrV1Compatible());
413-
BOOST_CHECK_EQUAL(addr.ToString(), "1.2.3.4");
413+
BOOST_CHECK_EQUAL(addr.ToStringAddr(), "1.2.3.4");
414414
BOOST_REQUIRE(s.empty());
415415

416416
// Invalid IPv4, valid length but address itself is shorter.
@@ -447,7 +447,7 @@ BOOST_AUTO_TEST_CASE(cnetaddr_unserialize_v2)
447447
BOOST_CHECK(addr.IsValid());
448448
BOOST_CHECK(addr.IsIPv6());
449449
BOOST_CHECK(addr.IsAddrV1Compatible());
450-
BOOST_CHECK_EQUAL(addr.ToString(), "102:304:506:708:90a:b0c:d0e:f10");
450+
BOOST_CHECK_EQUAL(addr.ToStringAddr(), "102:304:506:708:90a:b0c:d0e:f10");
451451
BOOST_REQUIRE(s.empty());
452452

453453
// Valid IPv6, contains embedded "internal".
@@ -459,7 +459,7 @@ BOOST_AUTO_TEST_CASE(cnetaddr_unserialize_v2)
459459
s >> addr;
460460
BOOST_CHECK(addr.IsInternal());
461461
BOOST_CHECK(addr.IsAddrV1Compatible());
462-
BOOST_CHECK_EQUAL(addr.ToString(), "zklycewkdo64v6wc.internal");
462+
BOOST_CHECK_EQUAL(addr.ToStringAddr(), "zklycewkdo64v6wc.internal");
463463
BOOST_REQUIRE(s.empty());
464464

465465
// Invalid IPv6, with bogus length.
@@ -505,7 +505,7 @@ BOOST_AUTO_TEST_CASE(cnetaddr_unserialize_v2)
505505
BOOST_CHECK(addr.IsValid());
506506
BOOST_CHECK(addr.IsTor());
507507
BOOST_CHECK(!addr.IsAddrV1Compatible());
508-
BOOST_CHECK_EQUAL(addr.ToString(),
508+
BOOST_CHECK_EQUAL(addr.ToStringAddr(),
509509
"pg6mmjiyjmcrsslvykfwnntlaru7p5svn6y2ymmju6nubxndf4pscryd.onion");
510510
BOOST_REQUIRE(s.empty());
511511

@@ -528,7 +528,7 @@ BOOST_AUTO_TEST_CASE(cnetaddr_unserialize_v2)
528528
BOOST_CHECK(addr.IsValid());
529529
BOOST_CHECK(addr.IsI2P());
530530
BOOST_CHECK(!addr.IsAddrV1Compatible());
531-
BOOST_CHECK_EQUAL(addr.ToString(),
531+
BOOST_CHECK_EQUAL(addr.ToStringAddr(),
532532
"ukeu3k5oycgaauneqgtnvselmt4yemvoilkln7jpvamvfx7dnkdq.b32.i2p");
533533
BOOST_REQUIRE(s.empty());
534534

@@ -551,7 +551,7 @@ BOOST_AUTO_TEST_CASE(cnetaddr_unserialize_v2)
551551
BOOST_CHECK(addr.IsValid());
552552
BOOST_CHECK(addr.IsCJDNS());
553553
BOOST_CHECK(!addr.IsAddrV1Compatible());
554-
BOOST_CHECK_EQUAL(addr.ToString(), "fc00:1:2:3:4:5:6:7");
554+
BOOST_CHECK_EQUAL(addr.ToStringAddr(), "fc00:1:2:3:4:5:6:7");
555555
BOOST_REQUIRE(s.empty());
556556

557557
// Invalid CJDNS, wrong prefix.

‎src/test/netbase_tests.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ BOOST_AUTO_TEST_CASE(embedded_test)
155155
CNetAddr addr1(ResolveIP("1.2.3.4"));
156156
CNetAddr addr2(ResolveIP("::FFFF:0102:0304"));
157157
BOOST_CHECK(addr2.IsIPv4());
158-
BOOST_CHECK_EQUAL(addr1.ToString(), addr2.ToString());
158+
BOOST_CHECK_EQUAL(addr1.ToStringAddr(), addr2.ToStringAddr());
159159
}
160160

161161
BOOST_AUTO_TEST_CASE(subnet_test)
@@ -240,7 +240,7 @@ BOOST_AUTO_TEST_CASE(subnet_test)
240240

241241
subnet = CSubNet(tor_addr);
242242
BOOST_CHECK(subnet.IsValid());
243-
BOOST_CHECK_EQUAL(subnet.ToString(), tor_addr.ToString());
243+
BOOST_CHECK_EQUAL(subnet.ToString(), tor_addr.ToStringAddr());
244244
BOOST_CHECK(subnet.Match(tor_addr));
245245
BOOST_CHECK(
246246
!subnet.Match(ResolveIP("kpgvmscirrdqpekbqjsvw5teanhatztpp2gl6eee4zkowvwfxwenqaid.onion")));

0 commit comments

Comments
 (0)